http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/9694fb23/docs/latest/development/traffic_ops_api/v12/deliveryservice.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html deleted file mode 100644 index b182c6a..0000000 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html +++ /dev/null @@ -1,3041 +0,0 @@ - - -<!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 — Traffic Control 1.8.1 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="index" title="Index" - href="../../../genindex.html"/> - <link rel="search" title="Search" href="../../../search.html"/> - <link rel="top" title="Traffic Control 1.8.1 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.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â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â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> - - </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 1.8.1</a> »</li> - - <li><a href="../../index.html">Developerâs Guide</a> »</li> - - <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> - - <li>Delivery Service</li> - <li class="wy-breadcrumbs-aside"> - - <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice.rst.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>Response Properties</strong></p> -<table border="1" class="docutils"> -<colgroup> -<col width="15%" /> -<col width="5%" /> -<col width="80%" /> -</colgroup> -<thead valign="bottom"> -<tr class="row-odd"><th class="head">Parameter</th> -<th class="head">Type</th> -<th class="head">Description</th> -</tr> -</thead> -<tbody valign="top"> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td> -<td>bool</td> -<td>true if active, false if inactive.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> -<td>string</td> -<td>Cache URL rule to apply to this delivery service.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> -<td>string</td> -<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> -<td>string</td> -<td>Id of the CDN to which the delivery service belongs to.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> -<td>string</td> -<td>Name of the CDN to which the delivery service belongs to.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td> -<td>string</td> -<td>The path portion of the URL to check this deliveryservice for health.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> -<td>string</td> -<td>The display name of the delivery service.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> -<td>string</td> -<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the -globalMaxMbps traffic on this deliveryservice.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> -<td>string</td> -<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the -globalMaxMbps traffic on this deliveryservice.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> -<td>string</td> -<td>The TTL of the DNS bypass response.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> -<td>string</td> -<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> -<td>string</td> -<td>The EDGE header rewrite actions to perform.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td> -<td>string</td> -<td><ul class="first simple"> -<li>0: None - no limitations</li> -<li>1: Only route on CZF file hit</li> -<li>2: Only route on CZF hit or when from USA</li> -</ul> -<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents -routing to the content by Traffic Router.</p> -</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> -<td>string</td> -<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the -dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td> -<td>string</td> -<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded -traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for -HTTP deliveryservices</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td> -<td>string</td> -<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the -globalMaxMbps traffic on this deliveryservice.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> -<td>string</td> -<td>The deliveryservice id (database row number).</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td> -<td>string</td> -<td>Use this to add a URL that points to more information about that deliveryservice.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td> -<td>bool</td> -<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> -<td>bool</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td> -<td>string</td> -<td>Description field 1.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> -<td>string</td> -<td>Description field 2.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td> -<td>string</td> -<td>Description field 2.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> -<td>string</td> -<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=âregexâ).</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> -<td>string</td> -<td>The set Number of the matchList.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> -<td>string</td> -<td>The regexp for the matchList.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> -<td>string</td> -<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all -available).</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> -<td>string</td> -<td>The MID header rewrite actions to perform.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> -<td>string</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> -<td>string</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> -<td>bool</td> -<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td> -<td>bool</td> -<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td> -<td>string</td> -<td>The origin server base URL (FQDN when used in this instance, includes the -protocol (<a class="reference external" href="http://";>http://</a> or <a class="reference external" href="https://";>https://</a>) for use in retrieving content from the origin server.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> -<td>string</td> -<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> -<td>string</td> -<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td> -<td>string</td> -<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td> -<td>string</td> -<td><ul class="first last simple"> -<li>0: serve with <a class="reference external" href="http://";>http://</a> at EDGE</li> -<li>1: serve with <a class="reference external" href="https://";>https://</a> at EDGE</li> -<li>2: serve with both <a class="reference external" href="http://";>http://</a> and <a class="reference external" href="https://";>https://</a> at EDGE</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> -<td>string</td> -<td><ul class="first last simple"> -<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> -<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> -<li>2: drop query string at edge, and do not use it in the cache-key.</li> -</ul> -</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> -<td>string</td> -<td><p class="first">How to treat range requests:</p> -<ul class="last simple"> -<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> -<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html";>background_fetch</a> plugin.</li> -<li>2 Use the cache_range_requests plugin.</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td> -<td>string</td> -<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> -<td>bool</td> -<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td> -<td>string</td> -<td>Additional raw remap line text.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td> -<td>bool</td> -<td><ul class="first last simple"> -<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> -<li>true: token based auth is enabled for this deliveryservice.</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> -<td>string</td> -<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> -<td>string</td> -<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> -<td>string</td> -<td>Unique string that describes this deliveryservice.</td> -</tr> -</tbody> -</table> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> - <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> - <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> - <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> - <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> - <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> - <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> - <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> - <span class="p">],</span> - <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> - <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> - <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> - <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> - <span class="p">}</span> - <span class="p">],</span> - <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> - <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> - <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> - <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> - <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> - <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> - <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> - <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> - <span class="p">}</span> - <span class="p">{</span> <span class="o">..</span> <span class="p">},</span> - <span class="p">{</span> <span class="o">..</span> <span class="p">}</span> - <span class="p">]</span> -<span class="p">}</span> -</pre></div> -</div> -</div></blockquote> -<div class="line-block"> -<div class="line"><br /></div> -</div> -<p><strong>GET /api/1.2/deliveryservices/:id</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>Response Properties</strong></p> -<table border="1" class="docutils"> -<colgroup> -<col width="15%" /> -<col width="5%" /> -<col width="80%" /> -</colgroup> -<thead valign="bottom"> -<tr class="row-odd"><th class="head">Parameter</th> -<th class="head">Type</th> -<th class="head">Description</th> -</tr> -</thead> -<tbody valign="top"> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">active</span></code></td> -<td>bool</td> -<td>true if active, false if inactive.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> -<td>string</td> -<td>Cache URL rule to apply to this delivery service.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> -<td>string</td> -<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> -<td>string</td> -<td>Id of the CDN to which the delivery service belongs to.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> -<td>string</td> -<td>Name of the CDN to which the delivery service belongs to.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td> -<td>string</td> -<td>The path portion of the URL to check this deliveryservice for health.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> -<td>string</td> -<td>The display name of the delivery service.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> -<td>string</td> -<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the -globalMaxMbps traffic on this deliveryservice.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> -<td>string</td> -<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the -globalMaxMbps traffic on this deliveryservice.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> -<td>string</td> -<td>The TTL of the DNS bypass response.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> -<td>string</td> -<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> -<td>string</td> -<td>The EDGE header rewrite actions to perform.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td> -<td>array</td> -<td>Entry points into the CDN for this deliveryservice.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td> -<td>string</td> -<td><ul class="first simple"> -<li>0: None - no limitations</li> -<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> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> -<td>string</td> -<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> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td> -<td>bool</td> -<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> -<td>bool</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td> -<td>string</td> -<td>Description field 1.</td> -</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">>>type</span></code></td> -<td>string</td> -<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=âregexâ).</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> -<td>string</td> -<td>The set Number of the matchList.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> -<td>string</td> -<td>The regexp for the matchList.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> -<td>string</td> -<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all -available).</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> -<td>string</td> -<td>The MID header rewrite actions to perform.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> -<td>string</td> -<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> -<td>string</td> -<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> -<td>bool</td> -<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td> -<td>bool</td> -<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td> -<td>string</td> -<td>The origin server base URL (FQDN when used in this instance, includes the -protocol (<a class="reference external" href="http://";>http://</a> or <a class="reference external" href="https://";>https://</a>) for use in retrieving content from the origin server.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> -<td>string</td> -<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> -<td>string</td> -<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td> -<td>string</td> -<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td> -<td>string</td> -<td><ul class="first last simple"> -<li>0: serve with <a class="reference external" href="http://";>http://</a> at EDGE</li> -<li>1: serve with <a class="reference external" href="https://";>https://</a> at EDGE</li> -<li>2: serve with both <a class="reference external" href="http://";>http://</a> and <a class="reference external" href="https://";>https://</a> at EDGE</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> -<td>string</td> -<td><ul class="first last simple"> -<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> -<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> -<li>2: drop query string at edge, and do not use it in the cache-key.</li> -</ul> -</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> -<td>string</td> -<td><p class="first">How to treat range requests:</p> -<ul class="last simple"> -<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> -<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html";>background_fetch</a> plugin.</li> -<li>2 Use the cache_range_requests plugin.</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td> -<td>string</td> -<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> -<td>bool</td> -<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td> -<td>string</td> -<td>Additional raw remap line text.</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td> -<td>bool</td> -<td><ul class="first last simple"> -<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> -<li>true: token based auth is enabled for this deliveryservice.</li> -</ul> -</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> -<td>string</td> -<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> -<td>string</td> -<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> -<td>string</td> -<td>Unique string that describes this deliveryservice.</td> -</tr> -</tbody> -</table> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> - <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> - <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> - <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> - <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> - <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> - <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> - <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> - <span class="p">],</span> - <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> - <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> - <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> - <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> - <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> - <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> - <span class="p">}</span> - <span class="p">],</span> - <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> - <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> - <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> - <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> - <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> - <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> - <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> - <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> - <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> - <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> - <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> - <span class="p">}</span> - <span class="p">]</span> -<span class="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> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>locations</span></code></td> -<td>array</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>destination</span></code></td> -<td>hash</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>location</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>configured</span></code></td> -<td>boolean</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">>enabled</span></code></td> -<td>boolean</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">enabled</span></code></td> -<td>boolean</td> -<td> </td> -</tr> -</tbody> -</table> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span> - <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> - <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span> - <span class="p">},</span> - <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> - <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span> - <span class="p">},</span> - <span class="s2">"enabled"</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">>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">>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">>name</span></code></td> -<td>string</td> -<td>Cache group name.</td> -</tr> -</tbody> -</table> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span> - <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span> - <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span> - <span class="p">},</span> - <span class="p">{</span> - <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span> - <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span> - <span class="p">}</span> - <span class="p">]</span> - <span class="p">}</span> -<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-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span> - <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span> - <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span> - <span class="p">},</span> -<span class="p">}</span> -</pre></div> -</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-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span> - <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span> - <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> - <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span> - <span class="p">},</span> -<span class="p">}</span> -</pre></div> -</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> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">server</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td> -<td>string</td> -<td> </td> -</tr> -</tbody> -</table> -<p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> - <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> - <span class="p">{</span> - <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span> - <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span> - <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span> - <span class="p">},</span> - <span class="p">{</span> - <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span> - <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span> - <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span> - <span class="p">},</span> - <span class="p">],</span> - <span class="s2">"limit"</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="11%" /> -<col width="5%" /> -<col width="84%" /> -</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">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 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">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-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span> - <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> - <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span> - <span class="p">},</span> - <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span> - <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span> - <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span> - <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span> - <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span> - <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span> - <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span> - <span class="p">}</span> -<span class="p">}</span> -</pre></div> -</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="11%" /> -<col width="5%" /> -<col width="84%" /> -</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">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 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">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-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span> - <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span> - <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> - <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span> - <span class="p">},</span> - <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span> - <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span> - <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span> - <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span> - <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span> - <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span> - <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span> - <span class="p">}</span> -<span class="p">}</span> -</pre></div> -</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-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span> -<span class="p">}</span> -</pre></div> -</div> -</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> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">org</span></code></td> -<td>string</td> -<td> </td> -</tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">unit</span></code></td> -<td>boolean</td> -<td> </td> -</tr> -</tbody> -</table> -<p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> - <span class="s2">"key"</span><span class="p">:</span> <span
<TRUNCATED>
