| |
| |
| |
| |
| <!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_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> |
| </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> |
| <li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 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="17%" /> |
| <col width="5%" /> |
| <col width="78%" /> |
| </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">anonymousBlockingEnabled</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-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 delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> |
| <td>float</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. 39.7391500 or null</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> |
| <td>float</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. -104.9847000 or null</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>int</td> |
| <td>How to treat range requests: |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| - 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. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td>List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td>List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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></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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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="17%" /> |
| <col width="5%" /> |
| <col width="78%" /> |
| </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">anonymousBlockingEnabled</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-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 delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-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">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 notranslate"><span class="pre">id</span></code></td> |
| <td>int</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> |
| <td>float</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. 39.7391500 or null</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> |
| <td>float</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. -104.9847000 or null</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>int</td> |
| <td>How to treat range requests: |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| - 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. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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></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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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></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">"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 (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></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">"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/eligible</strong></p> |
| <blockquote> |
| <div><p>Retrieves properties of CDN EDGE or ORG servers not eligible for assignment 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></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">"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> |
| </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. Delivery service must be assigned to user if user is not admin or operations.</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 notranslate"><span class="pre">failover</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>locations</span></code></td> |
| <td>array</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>destination</span></code></td> |
| <td>hash</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>location</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>configured</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>enabled</span></code></td> |
| <td>boolean</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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. Delivery service must be assigned to user if user is not admin or operations.</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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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. Delivery service must be assigned to user if user is not admin or operations.</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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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. Delivery service must be assigned to user if user is not admin or operations.</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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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="delivery-service-server"> |
| <span id="to-api-v12-ds-server"></span><h2>Delivery Service Server<a class="headerlink" href="#delivery-service-server" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/deliveryserviceserver</strong></p> |
| <blockquote> |
| <div><p>Retrieves delivery service / server assignments.</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="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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>array</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">server</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><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> |
| <p><strong>POST /api/1.2/deliveryserviceserver</strong></p> |
| <blockquote> |
| <div><p>Create one or more delivery service / server assignments.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Operations or the delivery service is assigned to the user.</p> |
| <p><strong>Request Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="30%" /> |
| <col width="9%" /> |
| <col width="61%" /> |
| </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">dsId</span></code></td> |
| <td>yes</td> |
| <td>The ID of the delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servers</span></code></td> |
| <td>yes</td> |
| <td>An array of server IDs.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td> |
| <td>no</td> |
| <td>Replace existing ds/server assignments? (true|false)</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"dsId"</span><span class="p">:</span> <span class="mi">246</span><span class="p">,</span> |
| <span class="s2">"servers"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span> |
| <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="32%" /> |
| <col width="7%" /> |
| <col width="60%" /> |
| </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">dsId</span></code></td> |
| <td>int</td> |
| <td>The ID of the delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servers</span></code></td> |
| <td>array</td> |
| <td>An array of server IDs.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td> |
| <td>array</td> |
| <td>Existing ds/server assignments replaced? (true|false).</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server assignments complete."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"dsId"</span> <span class="p">:</span> <span class="mi">246</span><span class="p">,</span> |
| <span class="s2">"servers"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span> |
| <span class="s2">"replace"</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>DELETE /api/1.2/deliveryservice_server/:dsId/:serverId</strong></p> |
| <blockquote> |
| <div><p>Removes a server (cache) from a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Oper (if delivery service is not 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">dsId</span></code></td> |
| <td>yes</td> |
| <td>Delivery service ID.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td> |
| <td>yes</td> |
| <td>Server (cache) ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <div><p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server unlinked from delivery service."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </div> |
| <div class="section" id="delivery-service-user"> |
| <span id="to-api-v12-ds-user"></span><h2>Delivery Service User<a class="headerlink" href="#delivery-service-user" title="Permalink to this headline">¶</a></h2> |
| <p><strong>POST /api/1.2/deliveryservice_user</strong></p> |
| <blockquote> |
| <div><p>Create one or more user / delivery service assignments.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Operations</p> |
| <p><strong>Request Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="30%" /> |
| <col width="9%" /> |
| <col width="61%" /> |
| </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">userId</span></code></td> |
| <td>yes</td> |
| <td>The ID of the user.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td> |
| <td>yes</td> |
| <td>An array of delivery service IDs.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td> |
| <td>no</td> |
| <td>Replace existing user/ds assignments? (true|false).</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"userId"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span> |
| <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</span> <span class="p">],</span> |
| <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="32%" /> |
| <col width="7%" /> |
| <col width="60%" /> |
| </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">userId</span></code></td> |
| <td>int</td> |
| <td>The ID of the user.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td> |
| <td>array</td> |
| <td>An array of delivery service IDs.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td> |
| <td>array</td> |
| <td>Existing user/ds assignments replaced? (true|false).</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service assignments complete."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"userId"</span> <span class="p">:</span> <span class="mi">50</span><span class="p">,</span> |
| <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</span> <span class="p">],</span> |
| <span class="s2">"replace"</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>DELETE /api/1.2/deliveryservice_user/:dsId/:userId</strong></p> |
| <blockquote> |
| <div><p>Removes a delivery service from a user.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Operations</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">dsId</span></code></td> |
| <td>yes</td> |
| <td>Delivery service ID.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">userId</span></code></td> |
| <td>yes</td> |
| <td>User ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <div><p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"User and delivery service were unlinked."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </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>Retrieves ssl keys for 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="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 notranslate"><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="19%" /> |
| <col width="15%" /> |
| <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 notranslate"><span class="pre">version</span></code></td> |
| <td>no</td> |
| <td>The version number to retrieve</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">decode</span></code></td> |
| <td>no</td> |
| <td>a boolean value to decode the certs or not</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) crt file for delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) csr file for delivery service</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) private key file for delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>The CDN of the delivery service for which the certs were generated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td> |
| <td>string</td> |
| <td>The XML ID of the delivery service for which the cert was generated.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">hostname</span></code></td> |
| <td>string</td> |
| <td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
| This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"my-ds"</span><span class="p">,</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"qa"</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 notranslate"><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="19%" /> |
| <col width="15%" /> |
| <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 notranslate"><span class="pre">version</span></code></td> |
| <td>no</td> |
| <td>The version number to retrieve</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">decode</span></code></td> |
| <td>no</td> |
| <td>a boolean value to decode the certs or not</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) crt file for delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) csr file for delivery service</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td> |
| <td>string</td> |
| <td>base64 encoded (or not if decode=true) private key file for delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>The CDN of the delivery service for which the certs were generated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td> |
| <td>string</td> |
| <td>The XML ID of the delivery service for which the cert was generated.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">hostname</span></code></td> |
| <td>string</td> |
| <td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
| This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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">"deliveryservice"</span><span class="p">:</span> <span class="s2">"my-ds"</span><span class="p">,</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"qa"</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: Operations</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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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: Operations</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="9%" /> |
| <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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">country</span></code></td> |
| <td>string</td> |
| <td>Country</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> |
| <td>string</td> |
| <td>State</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> |
| <td>string</td> |
| <td>City</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">org</span></code></td> |
| <td>string</td> |
| <td>Organization</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unit</span></code></td> |
| <td>boolean</td> |
| <td>Business Unit</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td> |
| <td>string</td> |
| <td>The deliveryservice xml-id for which you want to generate certs</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>The name of the CDN for which the deliveryservice belongs</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span> |
| <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span> |
| <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span> |
| <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span> |
| <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span> |
| <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span> |
| <span class="p">},</span> |
| <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span> |
| <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span> |
| <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span> |
| <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span> |
| <span class="s2">"deliveryservice"</span> <span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span> |
| <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn1"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="36%" /> |
| <col width="21%" /> |
| <col width="44%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> |
| <td>string</td> |
| <td>response string</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td>API version</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/deliveryservices/sslkeys/add</strong></p> |
| <blockquote> |
| <div><p>Allows user to add SSL crt, csr, and private key for a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operations</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="9%" /> |
| <col width="69%" /> |
| </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">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 notranslate"><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 notranslate"><span class="pre">csr</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td> |
| <td>string</td> |
| <td>The deliveryservice xml-id for which you want to generate certs</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td> |
| <td>string</td> |
| <td>The name of the CDN for which the deliveryservice belongs</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td> |
| <td>string</td> |
| <td>the <em>pristine hostname</em> of the delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span> |
| <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span> |
| <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span> |
| <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="36%" /> |
| <col width="21%" /> |
| <col width="44%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> |
| <td>string</td> |
| <td>response string</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td>API version</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully added ssl keys for ds-01"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div> |
| <div class="section" id="url-sig-keys"> |
| <h2>URL Sig Keys<a class="headerlink" href="#url-sig-keys" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys</strong></p> |
| <blockquote> |
| <div><p>Retrieves URL sig keys for 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="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 notranslate"><span class="pre">xmlId</span></code></td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key0</span></code></td> |
| <td>string</td> |
| <td>base64 encoded key for delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">key2</span></code></td> |
| <td>string</td> |
| <td>base64 encoded key for delivery service</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyn...</span></code></td> |
| <td>string</td> |
| <td>base64 encoded key for delivery service – repeats to 15 (16 total) and is currently unsorted.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><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="n">key9</span><span class="s2">":"</span><span class="n">ZvVQNYpPVQWQV8tjQnUl6osm4y7xK4zD</span><span class="s2">",</span> |
| <span class="s2">"key6"</span><span class="p">:</span><span class="s2">"JhGdpw5X9o8TqHfgezCm0bqb9SQPASWL"</span><span class="p">,</span> |
| <span class="s2">"key8"</span><span class="p">:</span><span class="s2">"ySXdp1T8IeDEE1OCMftzZb9EIw_20wwq"</span><span class="p">,</span> |
| <span class="s2">"key0"</span><span class="p">:</span><span class="s2">"D4AYzJ1AE2nYisA9MxMtY03TPDCHji9C"</span><span class="p">,</span> |
| <span class="s2">"key3"</span><span class="p">:</span><span class="s2">"W90YHlGc_kYlYw5_I0LrkpV9JOzSIneI"</span><span class="p">,</span> |
| <span class="s2">"key12"</span><span class="p">:</span><span class="s2">"ZbtMb3mrKqfS8hnx9_xWBIP_OPWlUpzc"</span><span class="p">,</span> |
| <span class="s2">"key2"</span><span class="p">:</span><span class="s2">"0qgEoDO7sUsugIQemZbwmMt0tNCwB1sf"</span><span class="p">,</span> |
| <span class="s2">"key4"</span><span class="p">:</span><span class="s2">"aFJ2Gb7atmxVB8uv7T9S6OaDml3ycpGf"</span><span class="p">,</span> |
| <span class="s2">"key1"</span><span class="p">:</span><span class="s2">"wnWNR1mCz1O4C7EFPtcqHd0xUMQyNFhA"</span><span class="p">,</span> |
| <span class="s2">"key11"</span><span class="p">:</span><span class="s2">"k6HMzlBH1x6htKkypRFfWQhAndQqe50e"</span><span class="p">,</span> |
| <span class="s2">"key10"</span><span class="p">:</span><span class="s2">"zYONfdD7fGYKj4kLvIj4U0918csuZO0d"</span><span class="p">,</span> |
| <span class="s2">"key15"</span><span class="p">:</span><span class="s2">"3360cGaIip_layZMc_0hI2teJbazxTQh"</span><span class="p">,</span> |
| <span class="s2">"key5"</span><span class="p">:</span><span class="s2">"SIwv3GOhWN7EE9wSwPFj18qE4M07sFxN"</span><span class="p">,</span> |
| <span class="s2">"key13"</span><span class="p">:</span><span class="s2">"SqQKBR6LqEOzp8AewZUCVtBcW_8YFc1g"</span><span class="p">,</span> |
| <span class="s2">"key14"</span><span class="p">:</span><span class="s2">"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ"</span><span class="p">,</span> |
| <span class="s2">"key7"</span><span class="p">:</span><span class="s2">"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"</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>POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/generate</strong></p> |
| <blockquote> |
| <div><p>Generates Url sig keys for a delivery service</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operations</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 notranslate"><span class="pre">xmlId</span></code></td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="36%" /> |
| <col width="21%" /> |
| <col width="44%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> |
| <td>string</td> |
| <td>response string</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td>API version</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully generated and stored keys"</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/xmlId/:xmlid/urlkeys/copyFromXmlId/:copyFromXmlId</strong></p> |
| <blockquote> |
| <div><p>Allows user to copy url sig keys from a specified delivery service to a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operations</p> |
| </div></blockquote> |
| <p><strong>Request Route Parameters</strong></p> |
| <blockquote> |
| <div><table border="1" class="docutils"> |
| <colgroup> |
| <col width="22%" /> |
| <col width="11%" /> |
| <col width="67%" /> |
| </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">xmlId</span></code></td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">copyFromXmlId</span></code></td> |
| <td>yes</td> |
| <td>xml_id of the delivery service to copy url sig keys from</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="36%" /> |
| <col width="21%" /> |
| <col width="44%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> |
| <td>string</td> |
| <td>response string</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td>API version</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully copied and stored keys"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p><strong>POST /api/1.2/deliveryservices/request</strong></p> |
| <blockquote> |
| <div><p>Allows a user to send delivery service request details to a specified email address.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="26%" /> |
| <col width="5%" /> |
| <col width="7%" /> |
| <col width="62%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</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">emailTo</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>The email to which the delivery service request will be sent.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">details</span></code></td> |
| <td>hash</td> |
| <td>yes</td> |
| <td>Parameters for the delivery service request.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>customer</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Name of the customer to associated with the delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>deepCachingType</span></code></td> |
| <td>string</td> |
| <td>no</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-even"><td><code class="docutils literal notranslate"><span class="pre">>deliveryProtocol</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Eg. http or http/https</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>routingType</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Eg. DNS or HTTP Redirect</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>routingName</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>The routing name for the delivery service, e.g. <routingName>.<xmlId>.cdn.com</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>serviceDesc</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>A description of the delivery service.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>peakBPSEstimate</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Used to manage cache efficiency and plan for capacity.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>peakTPSEstimate</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Used to manage cache efficiency and plan for capacity.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>maxLibrarySizeEstimate</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Used to manage cache efficiency and plan for capacity.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originURL</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>The URL path to the origin server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginDynamicRemap</span></code></td> |
| <td>bool</td> |
| <td>yes</td> |
| <td>This is a feature which allows services to use multiple origin URLs for the same service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originTestFile</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>A URL path to a test file available on the origin server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginACLWhitelist</span></code></td> |
| <td>bool</td> |
| <td>yes</td> |
| <td>Is access to your origin restricted using an access control list (ACL or whitelist) of Ips?</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originHeaders</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Header values that must be passed to requests to your origin.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>otherOriginSecurity</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Other origin security measures that need to be considered for access.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>queryStringHandling</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>How to handle query strings that come with the request.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rangeRequestHandling</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>How to handle range requests.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hasSignedURLs</span></code></td> |
| <td>bool</td> |
| <td>yes</td> |
| <td>Are Urls signed?</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasNegativeCachingCustomization</span></code></td> |
| <td>bool</td> |
| <td>yes</td> |
| <td>Any customization required for negative caching?</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>negativeCachingCustomizationNote</span></code></td> |
| <td>string</td> |
| <td>yes</td> |
| <td>Negative caching customization instructions.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>serviceAliases</span></code></td> |
| <td>array</td> |
| <td>no</td> |
| <td>Service aliases which will be used for this service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingGBPS</span></code></td> |
| <td>int</td> |
| <td>no</td> |
| <td>Rate Limiting - Bandwidth (Gbps)</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingTPS</span></code></td> |
| <td>int</td> |
| <td>no</td> |
| <td>Rate Limiting - Transactions/Second</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>overflowService</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>An overflow point (URL or IP address) used if rate limits are met.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteEdge</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Headers can be added or altered at each layer of the CDN.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteMid</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Headers can be added or altered at each layer of the CDN.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteRedirectRouter</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Headers can be added or altered at each layer of the CDN.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>notes</span></code></td> |
| <td>string</td> |
| <td>no</td> |
| <td>Additional instructions to provide the delivery service provisioning team.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"emailTo"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span><span class="p">,</span> |
| <span class="s2">"details"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span> |
| <span class="s2">"contentType"</span><span class="p">:</span> <span class="s2">"video-on-demand"</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">"deliveryProtocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span> |
| <span class="s2">"routingType"</span><span class="p">:</span> <span class="s2">"dns"</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">"serviceDesc"</span><span class="p">:</span> <span class="s2">"service description goes here"</span><span class="p">,</span> |
| <span class="s2">"peakBPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-5-Gbps"</span><span class="p">,</span> |
| <span class="s2">"peakTPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-1000-TPS"</span><span class="p">,</span> |
| <span class="s2">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s2">"less-than-200-GB"</span><span class="p">,</span> |
| <span class="s2">"originURL"</span><span class="p">:</span> <span class="s2">"http://myorigin.com"</span><span class="p">,</span> |
| <span class="s2">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"originTestFile"</span><span class="p">:</span> <span class="s2">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span> |
| <span class="s2">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"originHeaders"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"otherOriginSecurity"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"queryStringHandling"</span><span class="p">:</span> <span class="s2">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span> |
| <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"range-requests-not-used"</span><span class="p">,</span> |
| <span class="s2">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s2">"negative caching instructions"</span><span class="p">,</span> |
| <span class="s2">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"http://alias1.com"</span><span class="p">,</span> |
| <span class="s2">"http://alias2.com"</span> |
| <span class="p">],</span> |
| <span class="s2">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span> |
| <span class="s2">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span> |
| <span class="s2">"overflowService"</span><span class="p">:</span> <span class="s2">"http://overflowcdn.com"</span><span class="p">,</span> |
| <span class="s2">"headerRewriteEdge"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"headerRewriteMid"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"notes"</span><span class="p">:</span> <span class="s2">""</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <blockquote> |
| <div><p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="24%" /> |
| <col width="15%" /> |
| <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 notranslate"><span class="pre">alerts</span></code></td> |
| <td>array</td> |
| <td>A collection of alert messages.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> |
| <td>string</td> |
| <td>Success, info, warning or error.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> |
| <td>string</td> |
| <td>Alert message.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery Service request sent to foo@bar.com."</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>POST /api/1.2/deliveryservices</strong></p> |
| <blockquote> |
| <div><p>Allows user to create a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Operations</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="21%" /> |
| <col width="7%" /> |
| <col width="72%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>active</td> |
| <td>yes</td> |
| <td>true if active, false if inactive.</td> |
| </tr> |
| <tr class="row-odd"><td>anonymousBlockingEnabled</td> |
| <td>no</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td>cacheurl</td> |
| <td>no</td> |
| <td>Cache URL rule to apply to this delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td>ccrDnsTtl</td> |
| <td>no</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-even"><td>cdnId</td> |
| <td>yes</td> |
| <td>cdn id</td> |
| </tr> |
| <tr class="row-odd"><td>checkPath</td> |
| <td>no</td> |
| <td>The path portion of the URL to check this deliveryservice for health.</td> |
| </tr> |
| <tr class="row-even"><td>deepCachingType</td> |
| <td>no</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>displayName</td> |
| <td>yes</td> |
| <td>Display name</td> |
| </tr> |
| <tr class="row-even"><td>dnsBypassCname</td> |
| <td>no</td> |
| <td>Bypass CNAME</td> |
| </tr> |
| <tr class="row-odd"><td>dnsBypassIp</td> |
| <td>no</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>dnsBypassIp6</td> |
| <td>no</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>dnsBypassTtl</td> |
| <td>no</td> |
| <td>The TTL of the DNS bypass response.</td> |
| </tr> |
| <tr class="row-even"><td>dscp</td> |
| <td>yes</td> |
| <td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> |
| </tr> |
| <tr class="row-odd"><td>edgeHeaderRewrite</td> |
| <td>no</td> |
| <td>The EDGE header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-even"><td>fqPacingRate</td> |
| <td>no</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-odd"><td>geoLimitRedirectURL</td> |
| <td>no</td> |
| <td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td> |
| </tr> |
| <tr class="row-even"><td>geoLimit</td> |
| <td>yes</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 geo limit countries</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>geoLimitCountries</td> |
| <td>no</td> |
| <td>The geo limit countries.</td> |
| </tr> |
| <tr class="row-even"><td>geoProvider</td> |
| <td>yes</td> |
| <td><ul class="first last simple"> |
| <li>0: Maxmind(default)</li> |
| <li>1: Neustar</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td>globalMaxMbps</td> |
| <td>no</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>globalMaxTps</td> |
| <td>no</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>httpBypassFqdn</td> |
| <td>no</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>infoUrl</td> |
| <td>no</td> |
| <td>Use this to add a URL that points to more information about that deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td>initialDispersion</td> |
| <td>yes|no</td> |
| <td>Initial dispersion. Required for HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>ipv6RoutingEnabled</td> |
| <td>yes|no</td> |
| <td>false: send IPv4 address of Traffic Router to client on HTTP type del. |
| Required for DNS*, HTTP* and STEERING* delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td>logsEnabled</td> |
| <td>yes</td> |
| <td><ul class="first last simple"> |
| <li>false: No</li> |
| <li>true: Yes</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td>longDesc</td> |
| <td>no</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><td>longDesc1</td> |
| <td>no</td> |
| <td>Description field 1.</td> |
| </tr> |
| <tr class="row-even"><td>longDesc2</td> |
| <td>no</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-odd"><td>maxDnsAnswers</td> |
| <td>no</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>midHeaderRewrite</td> |
| <td>no</td> |
| <td>The MID header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-odd"><td>missLat</td> |
| <td>yes|no</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>missLong</td> |
| <td>yes|no</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td>multiSiteOrigin</td> |
| <td>yes|no</td> |
| <td>true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>orgServerFqdn</td> |
| <td>yes|no</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. This field is |
| required if type is DNS* or HTTP*.</td> |
| </tr> |
| <tr class="row-odd"><td>originShield</td> |
| <td>no</td> |
| <td>Origin shield</td> |
| </tr> |
| <tr class="row-even"><td>profileId</td> |
| <td>no</td> |
| <td>DS profile ID</td> |
| </tr> |
| <tr class="row-odd"><td>protocol</td> |
| <td>yes|no</td> |
| <td><ul class="first 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> |
| <p class="last">Required for DNS*, HTTP* or <em>STEERING</em> delivery services.</p> |
| </td> |
| </tr> |
| <tr class="row-even"><td>qstringIgnore</td> |
| <td>yes|no</td> |
| <td><ul class="first 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> |
| <p class="last">Required for DNS* and HTTP* delivery services.</p> |
| </td> |
| </tr> |
| <tr class="row-odd"><td>rangeRequestHandling</td> |
| <td>yes|no</td> |
| <td>How to treat range requests (required for DNS* and HTTP* delivery services): |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
| be a HIT) |
| - 1 Use the background_fetch plugin. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><td>regexRemap</td> |
| <td>no</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-odd"><td>regionalGeoBlocking</td> |
| <td>yes</td> |
| <td>Is the Regional Geo Blocking feature enabled.</td> |
| </tr> |
| <tr class="row-even"><td>remapText</td> |
| <td>no</td> |
| <td>Additional raw remap line text.</td> |
| </tr> |
| <tr class="row-odd"><td>routingName</td> |
| <td>yes</td> |
| <td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td> |
| </tr> |
| <tr class="row-even"><td>signed</td> |
| <td>no</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>signingAlgorithm</td> |
| <td>no</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-even"><td>sslKeyVersion</td> |
| <td>no</td> |
| <td>SSL key version</td> |
| </tr> |
| <tr class="row-odd"><td>tenantId</td> |
| <td>No</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td>trRequestHeaders</td> |
| <td>no</td> |
| <td>Traffic router log request headers</td> |
| </tr> |
| <tr class="row-odd"><td>trResponseHeaders</td> |
| <td>no</td> |
| <td>Traffic router additional response headers</td> |
| </tr> |
| <tr class="row-even"><td>typeId</td> |
| <td>yes</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-odd"><td>xmlId</td> |
| <td>yes</td> |
| <td>Unique string that describes this deliveryservice.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</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">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span> |
| <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> |
| <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</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">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span> |
| <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span> |
| <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="5%" /> |
| <col width="78%" /> |
| </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">anonymousBlockingEnabled</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-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 delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-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">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 notranslate"><span class="pre">id</span></code></td> |
| <td>int</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> |
| <td>float</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. 39.7391500 or null</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> |
| <td>float</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. -104.9847000 or null</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>int</td> |
| <td>How to treat range requests: |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| - 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. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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></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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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">"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>PUT /api/1.2/deliveryservices/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allows user to edit a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</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>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="18%" /> |
| <col width="7%" /> |
| <col width="74%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>active</td> |
| <td>yes</td> |
| <td>true if active, false if inactive.</td> |
| </tr> |
| <tr class="row-odd"><td>anonymousBlockingEnabled</td> |
| <td>no</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td>cacheurl</td> |
| <td>no</td> |
| <td>Cache URL rule to apply to this delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td>ccrDnsTtl</td> |
| <td>no</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-even"><td>cdnId</td> |
| <td>yes</td> |
| <td>cdn id</td> |
| </tr> |
| <tr class="row-odd"><td>checkPath</td> |
| <td>no</td> |
| <td>The path portion of the URL to check this deliveryservice for health.</td> |
| </tr> |
| <tr class="row-even"><td>deepCachingType</td> |
| <td>no</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>displayName</td> |
| <td>yes</td> |
| <td>Display name</td> |
| </tr> |
| <tr class="row-even"><td>dnsBypassCname</td> |
| <td>no</td> |
| <td>Bypass CNAME</td> |
| </tr> |
| <tr class="row-odd"><td>dnsBypassIp</td> |
| <td>no</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>dnsBypassIp6</td> |
| <td>no</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>dnsBypassTtl</td> |
| <td>no</td> |
| <td>The TTL of the DNS bypass response.</td> |
| </tr> |
| <tr class="row-even"><td>dscp</td> |
| <td>yes</td> |
| <td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> |
| </tr> |
| <tr class="row-odd"><td>edgeHeaderRewrite</td> |
| <td>no</td> |
| <td>The EDGE header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-even"><td>fqPacingRate</td> |
| <td>no</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-odd"><td>geoLimitRedirectURL</td> |
| <td>no</td> |
| <td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td> |
| </tr> |
| <tr class="row-even"><td>geoLimit</td> |
| <td>yes</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 geo limit countries</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>geoLimitCountries</td> |
| <td>no</td> |
| <td>The geo limit countries.</td> |
| </tr> |
| <tr class="row-even"><td>geoProvider</td> |
| <td>yes</td> |
| <td><ul class="first last simple"> |
| <li>0: Maxmind(default)</li> |
| <li>1: Neustar</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td>globalMaxMbps</td> |
| <td>no</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>globalMaxTps</td> |
| <td>no</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>httpBypassFqdn</td> |
| <td>no</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>infoUrl</td> |
| <td>no</td> |
| <td>Use this to add a URL that points to more information about that deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td>initialDispersion</td> |
| <td>yes|no</td> |
| <td>Initial dispersion. Required for HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>ipv6RoutingEnabled</td> |
| <td>yes|no</td> |
| <td>false: send IPv4 address of Traffic Router to client on HTTP type del. |
| Required for DNS*, HTTP* and STEERING* delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td>logsEnabled</td> |
| <td>yes</td> |
| <td><ul class="first last simple"> |
| <li>false: No</li> |
| <li>true: Yes</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td>longDesc</td> |
| <td>no</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><td>longDesc1</td> |
| <td>no</td> |
| <td>Description field 1.</td> |
| </tr> |
| <tr class="row-even"><td>longDesc2</td> |
| <td>no</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-odd"><td>maxDnsAnswers</td> |
| <td>no</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>midHeaderRewrite</td> |
| <td>no</td> |
| <td>The MID header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-odd"><td>missLat</td> |
| <td>yes|no</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>missLong</td> |
| <td>yes|no</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-odd"><td>multiSiteOrigin</td> |
| <td>yes|no</td> |
| <td>true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.</td> |
| </tr> |
| <tr class="row-even"><td>orgServerFqdn</td> |
| <td>yes|no</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. This field is |
| required if type is DNS* or HTTP*.</td> |
| </tr> |
| <tr class="row-odd"><td>originShield</td> |
| <td>no</td> |
| <td>Origin shield</td> |
| </tr> |
| <tr class="row-even"><td>profileId</td> |
| <td>no</td> |
| <td>DS profile ID</td> |
| </tr> |
| <tr class="row-odd"><td>protocol</td> |
| <td>yes|no</td> |
| <td><ul class="first 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> |
| <p class="last">Required for DNS*, HTTP* or <em>STEERING</em> delivery services.</p> |
| </td> |
| </tr> |
| <tr class="row-even"><td>qstringIgnore</td> |
| <td>yes|no</td> |
| <td><ul class="first 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> |
| <p class="last">Required for DNS* and HTTP* delivery services.</p> |
| </td> |
| </tr> |
| <tr class="row-odd"><td>rangeRequestHandling</td> |
| <td>yes|no</td> |
| <td>How to treat range requests (required for DNS* and HTTP* delivery services): |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
| be a HIT) |
| - 1 Use the background_fetch plugin. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><td>regexRemap</td> |
| <td>no</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-odd"><td>regionalGeoBlocking</td> |
| <td>yes</td> |
| <td>Is the Regional Geo Blocking feature enabled.</td> |
| </tr> |
| <tr class="row-even"><td>remapText</td> |
| <td>no</td> |
| <td>Additional raw remap line text.</td> |
| </tr> |
| <tr class="row-odd"><td>routingName</td> |
| <td>yes</td> |
| <td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td> |
| </tr> |
| <tr class="row-even"><td>signed</td> |
| <td>no</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>signingAlgorithm</td> |
| <td>no</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-even"><td>sslKeyVersion</td> |
| <td>no</td> |
| <td>SSL key version</td> |
| </tr> |
| <tr class="row-odd"><td>tenantId</td> |
| <td>No</td> |
| <td>Owning tenant ID</td> |
| </tr> |
| <tr class="row-even"><td>trRequestHeaders</td> |
| <td>no</td> |
| <td>Traffic router log request headers</td> |
| </tr> |
| <tr class="row-odd"><td>trResponseHeaders</td> |
| <td>no</td> |
| <td>Traffic router additional response headers</td> |
| </tr> |
| <tr class="row-even"><td>typeId</td> |
| <td>yes</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-odd"><td>xmlId</td> |
| <td>yes</td> |
| <td>Unique string that describes this deliveryservice. This value cannot be changed on update.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</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">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span> |
| <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> |
| <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</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">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span> |
| <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span> |
| <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="5%" /> |
| <col width="78%" /> |
| </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">anonymousBlockingEnabled</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-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 delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-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">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 notranslate"><span class="pre">id</span></code></td> |
| <td>int</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> |
| <td>float</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. 39.7391500 or null</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> |
| <td>float</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. -104.9847000 or null</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>int</td> |
| <td>How to treat range requests: |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| - 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. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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></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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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">"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>PUT /api/1.2/deliveryservices/{:id}/safe</strong></p> |
| <blockquote> |
| <div><p>Allows a user to edit limited fields of an assigned delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: users with the delivery service assigned or ops and above</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>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="7%" /> |
| <col width="76%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>displayName</td> |
| <td>no</td> |
| <td>Display name</td> |
| </tr> |
| <tr class="row-odd"><td>infoUrl</td> |
| <td>no</td> |
| <td>Use this to add a URL that points to more information about that deliveryservice.</td> |
| </tr> |
| <tr class="row-even"><td>longDesc</td> |
| <td>no</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><td>longDesc1</td> |
| <td>no</td> |
| <td>Description field 1.</td> |
| </tr> |
| <tr class="row-even"><td>all other fields</td> |
| <td>n/a</td> |
| <td>All other fields will be silently ignored</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></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">"infoUrl"</span><span class="p">:</span> <span class="s2">"www.info.com"</span><span class="p">,</span> |
| <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">"some info about the service"</span><span class="p">,</span> |
| <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">"the customer label"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="5%" /> |
| <col width="78%" /> |
| </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">anonymousBlockingEnabled</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>true: enable blocking clients with anonymous ips</li> |
| <li>false: disabled</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-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 delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-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">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 notranslate"><span class="pre">id</span></code></td> |
| <td>int</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field.</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td> |
| <td>float</td> |
| <td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. 39.7391500 or null</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td> |
| <td>float</td> |
| <td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| - e.g. -104.9847000 or null</td> |
| </tr> |
| <tr class="row-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>int</td> |
| <td>How to treat range requests: |
| - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
| - 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. |
| - 2 Use the cache_range_requests plugin.</td> |
| </tr> |
| <tr class="row-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td> |
| <td>int</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><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-even"><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></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">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</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">"www.info.com"</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">"some info about the service"</span><span class="p">,</span> |
| <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">"the customer label"</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">"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>DELETE /api/1.2/deliveryservices/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allows user to delete a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</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> |
| <blockquote> |
| <div><p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service was deleted."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/deliveryservices/:xml_id/servers</strong></p> |
| <blockquote> |
| <div><p>Assign caches to a delivery service.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="19%" /> |
| <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>xml_id</td> |
| <td>yes</td> |
| <td>the xml_id of the deliveryservice</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="11%" /> |
| <col width="8%" /> |
| <col width="82%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>serverNames</td> |
| <td>yes</td> |
| <td>array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"tc1_ats1"</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="11%" /> |
| <col width="6%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>xml_id</td> |
| <td>string</td> |
| <td>Unique string that describes this delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td>serverNames</td> |
| <td>string</td> |
| <td>array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <div><p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:{</span> |
| <span class="s2">"serverNames"</span><span class="p">:[</span> |
| <span class="s2">"tc1_ats1"</span> |
| <span class="p">],</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span><span class="s2">"my_ds_1"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </div> |
| <div class="section" id="uri-signing-keys"> |
| <h2>URI Signing Keys<a class="headerlink" href="#uri-signing-keys" title="Permalink to this headline">¶</a></h2> |
| <p><strong>DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> |
| <blockquote> |
| <div><p>Deletes URISigning objects for a delivery service.</p> |
| <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>xml_id</td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| </div></blockquote> |
| <p><strong>GET /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> |
| <blockquote> |
| <div><p>Retrieves one or more URISigning objects for a delivery service.</p> |
| <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>xml_id</td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td> |
| <td>string</td> |
| <td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td> |
| <td>string</td> |
| <td>a string naming the jwt key used for renewals.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td> |
| <td>string</td> |
| <td>json array of jwt symmetric keys .</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p><strong>POST /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> |
| <blockquote> |
| <div><p>Assigns URISigning objects to a delivery service.</p> |
| <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>xml_id</td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td> |
| <td>string</td> |
| <td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td> |
| <td>string</td> |
| <td>a string naming the jwt key used for renewals.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td> |
| <td>string</td> |
| <td>json array of jwt symmetric keys .</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p><strong>PUT /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p> |
| <blockquote> |
| <div><p>updates URISigning objects on a delivery service.</p> |
| <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>xml_id</td> |
| <td>yes</td> |
| <td>xml_id of the desired delivery service</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="5%" /> |
| <col width="83%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td> |
| <td>string</td> |
| <td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td> |
| <td>string</td> |
| <td>a string naming the jwt key used for renewals.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td> |
| <td>string</td> |
| <td>json array of jwt symmetric keys .</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td> |
| <td>string</td> |
| <td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span> |
| <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span> |
| <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span> |
| <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <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> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book">Apache Traffic Control (Incubating)</span> |
| v: |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="/docs/master/">latest</a></dd> |
| <dd><a href="/docs/2.0/">2.0</a></dd> |
| <dd><a href="/docs/1.8.1/">1.8</a></dd> |
| <dd><a href="/docs/1.7.0/">1.7</a></dd> |
| </dl> |
| <hr/> |
| Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. |
| |
| </div> |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../', |
| VERSION:'2.2-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
