| |
| |
| <!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><no title> — Traffic Control 1.8-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="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="/" class="icon icon-home"> Traffic Control |
| |
| |
| |
| |
| <img src="../../../_static/tc_logo_c_only.png" class="logo" /> |
| |
| </a> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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="../../index.html">Developer’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Traffic Control</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> |
| |
| <li><no title></li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../../../_sources/development/traffic_ops_api/v12/ConfigFiles-ApacheTrafficServer.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <p>Config Files and Config File Metadata |
| ===</p> |
| <p id="to-api-v12-configfiles-route">/api/1.2/servers/:hostname/configfiles/ats |
| /api/1.2/servers/:host_id/configfiles/ats |
| +++++++++++++</p> |
| <p><strong>GET /api/1.2/servers/:hostname/configfiles/ats</strong> |
| <strong>GET /api/1.2/servers/:host_id/configfiles/ats</strong></p> |
| <blockquote> |
| <div><p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operator</p> |
| <p><strong>Request Query Parameters</strong></p> |
| <p><strong>Response Properties</strong></p> |
| <p>+======================================================================================================+ |
| | Info Section | |
| +——————-+——–+————————————————————————-+ |
| | Parameter | Type | Description | |
| +===================+========+=========================================================================+ |
| | <code class="docutils literal"><span class="pre">profileId</span></code> | string | The ID of the profile assigned to the cache. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">profileName</span></code> | string | The name of the profile assigned to the cache. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">toRevProxyUrl</span></code> | string | The configured reverse proxy cache for configfile requests. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">toURL</span></code> | string | The configured URL for Traffic Ops. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverIpv4</span></code> | string | The configured IP address of the cache. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverName</span></code> | string | The cache’s short form hostname. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverId</span></code> | string | The cache’s Traffic Ops ID. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">cdnId</span></code> | string | The ID of the cache’s assigned CDN. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">cdnName</span></code> | string | The name of the cache’s assigned CDN. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">serverTcpPort</span></code> | string | The configured port of the server’s used by ATS. | |
| +======================================================================================================+ |
| | configFiles Section | |
| +——————-+——–+————————————————————————-+ |
| | Parameter | Type | Description | |
| +===================+========+=========================================================================+ |
| | <code class="docutils literal"><span class="pre">fnameOnDisk</span></code> | string | The filename of the configuration file as stored on the cache. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">location</span></code> | string | The directory location of the configuration file as stored on the cache.| |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">apiUri</span></code> | string | The path to generate the configuration file from Traffic Ops. | |
| +——————-+——–+————————————————————————-+ |
| | <code class="docutils literal"><span class="pre">scope</span></code> | string | The scope of the configuration file. | |
| +——————-+——–+————————————————————————-+</p> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| </pre></div> |
| </div> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>“info”: {</dt> |
| <dd>“profileId”: 278, |
| “toRevProxyUrl”: “<a class="reference external" href="https://to.example.com:81">https://to.example.com:81</a>”, |
| “toUrl”: “<a class="reference external" href="https://to.example.com/">https://to.example.com/</a>”, |
| “serverIpv4”: “192.168.1.5”, |
| “serverTcpPort”: 80, |
| “serverName”: “cache-ats-01”, |
| “cdnId”: 1, |
| “cdnName”: “CDN_1”, |
| “serverId”: 21, |
| “profileName”: “EDGE_CDN_1_EXAMPLE”</dd> |
| </dl> |
| <p>}, |
| “configFiles”: [</p> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>{</dt> |
| <dd>“fnameOnDisk”: “remap.config”, |
| “location”: “/opt/trafficserver/etc/trafficserver”, |
| “apiUri”: “/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config”, |
| “scope”: “profiles”</dd> |
| </dl> |
| <p>}, |
| {</p> |
| <blockquote> |
| <div>“fnameOnDisk”: “ssl_multicert.config”, |
| “location”: “/opt/trafficserver/etc/trafficserver”, |
| “apiUri”: “/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config”, |
| “scope”: “cdns”</div></blockquote> |
| <p>}, |
| {</p> |
| <blockquote> |
| <div>“fnameOnDisk”: “parent.config”, |
| “location”: “/opt/trafficserver/etc/trafficserver”, |
| “apiUri”: “/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config”</div></blockquote> |
| <p>}</p> |
| </div></blockquote> |
| <p>]</p> |
| </div></blockquote> |
| <p>}</p> |
| </div></blockquote> |
| <p>/api/1.2/servers/:hostname/configfiles/ats/:configfile |
| /api/1.2/servers/:host_id/configfiles/ats/:configfile |
| +++++++++++++</p> |
| <p><strong>GET /api/1.2/servers/:hostname/configfiles/ats/:configfile</strong> |
| <strong>GET /api/1.2/servers/:host_id/configfiles/ats/:configfile</strong></p> |
| <blockquote> |
| <div><p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operator</p> |
| <p><strong>Request Query Parameters</strong></p> |
| <p><strong>Response Properties</strong></p> |
| <p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| </pre></div> |
| </div> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>“alerts”: [</dt> |
| <dd><dl class="first docutils"> |
| <dt>{</dt> |
| <dd>“level”: “error”, |
| “text”: “Error - incorrect file scope for route used. Please use the profiles route.”</dd> |
| </dl> |
| <p class="last">}</p> |
| </dd> |
| </dl> |
| <p>]</p> |
| </div></blockquote> |
| <p>}</p> |
| </div></blockquote> |
| <p>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile |
| /api/1.2/profiles/:profile_id/configfiles/ats/:configfile |
| +++++++++++++</p> |
| <p><strong>GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile</strong> |
| <strong>GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile</strong></p> |
| <blockquote> |
| <div><p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operator</p> |
| <p><strong>Request Query Parameters</strong></p> |
| <p><strong>Response Properties</strong></p> |
| <p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| </pre></div> |
| </div> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>“alerts”: [</dt> |
| <dd><dl class="first docutils"> |
| <dt>{</dt> |
| <dd>“level”: “error”, |
| “text”: “Error - incorrect file scope for route used. Please use the cdns route.”</dd> |
| </dl> |
| <p class="last">}</p> |
| </dd> |
| </dl> |
| <p>]</p> |
| </div></blockquote> |
| <p>}</p> |
| </div></blockquote> |
| <p>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile |
| /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile |
| +++++++++++++</p> |
| <p><strong>GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</strong> |
| <strong>GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile</strong></p> |
| <blockquote> |
| <div><p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Operator</p> |
| <p><strong>Request Query Parameters</strong></p> |
| <p><strong>Response Properties</strong></p> |
| <p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| </pre></div> |
| </div> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>“alerts”: [</dt> |
| <dd><dl class="first docutils"> |
| <dt>{</dt> |
| <dd>“level”: “error”, |
| “text”: “Error - incorrect file scope for route used. Please use the servers route.”</dd> |
| </dl> |
| <p class="last">}</p> |
| </dd> |
| </dl> |
| <p>]</p> |
| </div></blockquote> |
| <p>}</p> |
| </div></blockquote> |
| |
| |
| </div> |
| <footer> |
| |
| |
| <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> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../../', |
| VERSION:'1.8-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true |
| }; |
| </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> |
