http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/deliveryservice.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/deliveryservice.html b/docs/master/api/v12/deliveryservice.html new file mode 100644 index 0000000..8c037a6 --- /dev/null +++ b/docs/master/api/v12/deliveryservice.html @@ -0,0 +1,5983 @@ + + + + +<!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 2.2-dev 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 2.2-dev documentation" href="../../index.html"/> + <link rel="up" title="API 1.2 Reference" href="index.html"/> + <link rel="next" title="Delivery Service Regexes" href="deliveryservice_regex.html"/> + <link rel="prev" title="Config Files and Config File Metadata" href="configfiles_ats.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âs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</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/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<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> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</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 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li><a href="index.html">API 1.2 Reference</a> »</li> + + <li>Delivery Service</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/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_regex.html" class="btn btn-neutral float-right" title="Delivery Service Regexes">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="configfiles_ats.html" class="btn btn-neutral" title="Config Files and Config File Metadata"><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 (if admin or ops) or all delivery services assigned to user. 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 notranslate"><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 notranslate"><span class="pre">profile</span></code></td> +<td>no</td> +<td>Filter delivery services by Profile ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td> +<td>no</td> +<td>Filter delivery services by Tenant ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td> +<td>no</td> +<td>Filter delivery services by Type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> +<td>no</td> +<td>Filter by logs enabled (true|false).</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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">ccrDnsTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td> +<td>int</td> +<td>Id of the CDN to which the delivery service belongs to.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">deepCachingType</span></code></td> +<td>string</td> +<td><p class="first">When to do Deep Caching for this Delivery Service:</p> +<ul class="last simple"> +<li>NEVER (default)</li> +<li>ALWAYS</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td> +<td>string</td> +<td>The display name of the delivery service.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">dnsBypassTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS bypass response.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td> +<td>int</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td> +<td>int</td> +<td><ul class="first simple"> +<li>0: None - no limitations</li> +<li>1: Only route on CZF file hit</li> +<li>2: Only route on CZF hit or when from USA</li> +</ul> +<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents +routing to the content by Traffic Router.</p> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td> +<td>int</td> +<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the +dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td> +<td>int</td> +<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded +traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for +HTTP deliveryservices</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td> +<td>int</td> +<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, +will be rate limited by the Linux kernel. A default value of 0 disables this feature</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>The deliveryservice id (database row number).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">initialDispersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> +<td>bool</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> +<td>string</td> +<td>Description field.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td> +<td>string</td> +<td>Description field 1.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">maxDnsAnswers</span></code></td> +<td>int</td> +<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all +available).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td> +<td>string</td> +<td>The MID header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> +<td>float</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> +<td>float</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td> +<td>bool</td> +<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">originShield</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">profileId</span></code></td> +<td>int</td> +<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">protocol</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li> +<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li> +<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> +<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> +<li>2: drop query string at edge, and do not use it in the cache-key.</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> +<td>int</td> +<td><p class="first">How to treat range requests:</p> +<ul class="last simple"> +<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> +<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li> +<li>2 Use the cache_range_requests plugin.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">routingName</span></code></td> +<td>string</td> +<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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-even"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td> +<td>string</td> +<td><ul class="first last simple"> +<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> +<li>âurl_sigâ: URL Sign token based auth is enabled for this deliveryservice.</li> +<li>âuri_signingâ: URI Signing token based auth is enabled for this deliveryservice.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td> +<td>string</td> +<td>Owning tenant name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td> +<td>int</td> +<td>Owning tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> +<td>string</td> +<td>List of header keys separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed headers will be included in TR access log entries under the ârh=â token.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> +<td>string</td> +<td>List of header <code class="docutils literal notranslate"><span class="pre">name:value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed pairs will be included in all TR HTTP responses.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td> +<td>int</td> +<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><div class="highlight"><pre><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">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</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://foo.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">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> + <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> + <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> + <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> + <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> + <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</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">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</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">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> + <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</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. If not admin / ops, delivery service must be assigned to user. 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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">ccrDnsTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td> +<td>int</td> +<td>Id of the CDN to which the delivery service belongs to.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">deepCachingType</span></code></td> +<td>string</td> +<td><p class="first">When to do Deep Caching for this Delivery Service:</p> +<ul class="last simple"> +<li>NEVER (default)</li> +<li>ALWAYS</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td> +<td>string</td> +<td>The display name of the delivery service.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">dnsBypassTtl</span></code></td> +<td>int</td> +<td>The TTL of the DNS bypass response.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td> +<td>int</td> +<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td> +<td>int</td> +<td><ul class="first simple"> +<li>0: None - no limitations</li> +<li>1: Only route on CZF file hit</li> +<li>2: Only route on CZF hit or when from USA</li> +</ul> +<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents +routing to the content by Traffic Router.</p> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td> +<td>int</td> +<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the +dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td> +<td>int</td> +<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded +traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for +HTTP deliveryservices</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td> +<td>int</td> +<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, +will be rate limited by the Linux kernel. A default value of 0 disables this feature</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>The deliveryservice id (database row number).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">initialDispersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> +<td>bool</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> +<td>string</td> +<td>Description field.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td> +<td>string</td> +<td>Description field 1.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">matchList</span></code></td> +<td>array</td> +<td>Array of matchList hashes.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td> +<td>string</td> +<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=âregexâ).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td> +<td>string</td> +<td>The set Number of the matchList.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td> +<td>string</td> +<td>The regexp for the matchList.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td> +<td>int</td> +<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all +available).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td> +<td>string</td> +<td>The MID header rewrite actions to perform.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> +<td>float</td> +<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. 39.7391500 or null</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> +<td>float</td> +<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p> +<ul class="last simple"> +<li>e.g. -104.9847000 or null</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td> +<td>bool</td> +<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">originShield</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">profileId</span></code></td> +<td>int</td> +<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">protocol</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li> +<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li> +<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td> +<td>int</td> +<td><ul class="first last simple"> +<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> +<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> +<li>2: drop query string at edge, and do not use it in the cache-key.</li> +</ul> +</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> +<td>int</td> +<td><p class="first">How to treat range requests:</p> +<ul class="last simple"> +<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> +<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li> +<li>2 Use the cache_range_requests plugin.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">routingName</span></code></td> +<td>string</td> +<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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-even"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td> +<td>string</td> +<td><ul class="first last simple"> +<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> +<li>âurl_sigâ: URL Sign token based auth is enabled for this deliveryservice.</li> +<li>âuri_signingâ: URI Signing token based auth is enabled for this deliveryservice.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> +<td>int</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td> +<td>string</td> +<td>Owning tenant name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td> +<td>int</td> +<td>Owning tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> +<td>string</td> +<td>List of header keys separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed headers will be included in TR access log entries under the ârh=â token.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> +<td>string</td> +<td>List of header <code class="docutils literal notranslate"><span class="pre">name:value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed pairs will be included in all TR HTTP responses.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td> +<td>int</td> +<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=âdeliveryserviceâ).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><div class="highlight"><pre><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">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</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://foo.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">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> + <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> + <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span> + <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span> + <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> + <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> + <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</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">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</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">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> + <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> + <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/deliveryservices/:id/servers</strong></p> +<blockquote> +<div><p>Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user.</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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"><span class="std std-ref">Cache Group</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">iloPassword</span></code></td> +<td>string</td> +<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an âadminâ user).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">interfaceMtu</span></code></td> +<td>string</td> +<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">ip6Address</span></code></td> +<td>string</td> +<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td> +<td>string</td> +<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td> +<td>string</td> +<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td> +<td>string</td> +<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td> +<td>string</td> +<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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"><span class="std std-ref">Physical Location</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Physical Location</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Profiles</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Profiles</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Profiles</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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"><span class="std std-ref">Status</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Status</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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"><span class="std std-ref">Types</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Types</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td> +<td>bool</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> + <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> + <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span> + <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span> + <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span> + <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span> + <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span> + <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> + <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span> + <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span> + <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span> + <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> + <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span> + <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span> + <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span> + <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span> + <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span> + <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> + <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span> + <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> + <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span> + <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span> + <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span> + <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span> + <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span> + <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> + <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> + <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/deliveryservices/:id/servers/unassigned</strong></p> +<blockquote> +<div><p>Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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"><span class="std std-ref">Cache Group</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">iloPassword</span></code></td> +<td>string</td> +<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an âadminâ user).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">interfaceMtu</span></code></td> +<td>string</td> +<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">ip6Address</span></code></td> +<td>string</td> +<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td> +<td>string</td> +<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td> +<td>string</td> +<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td> +<td>string</td> +<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td> +<td>string</td> +<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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"><span class="std std-ref">Physical Location</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Physical Location</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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"><span class="std std-ref">Profiles</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td> +<td>string</td> +<td>The assigned profile description (se
<TRUNCATED>