http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/changelog.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/changelog.html b/docs/master/api/v12/changelog.html new file mode 100644 index 0000000..e3ef3f8 --- /dev/null +++ b/docs/master/api/v12/changelog.html @@ -0,0 +1,521 @@ + + + + +<!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>Change Logs — 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="Config Files and Config File Metadata" href="configfiles_ats.html"/> + <link rel="prev" title="CDN" href="cdn.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li><a href="index.html">API 1.2 Reference</a> »</li> + + <li>Change Logs</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/changelog.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="configfiles_ats.html" class="btn btn-neutral float-right" title="Config Files and Config File Metadata">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="cdn.html" class="btn btn-neutral" title="CDN"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="change-logs"> +<span id="to-api-v12-change-logs"></span><h1>Change Logs<a class="headerlink" href="#change-logs" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-logs"> +<span id="to-api-v12-change-logs-route"></span><h2>/api/1.2/logs<a class="headerlink" href="#api-1-2-logs" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/logs</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="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">days</span></code></td> +<td>no</td> +<td>The number of days of change logs to return.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">limit</span></code></td> +<td>no</td> +<td>The number of rows to limit the response to.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="8%" /> +<col width="75%" /> +</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">ticketNum</span></code></td> +<td>string</td> +<td>Optional field to cross reference with any bug tracking systems</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td> +<td>string</td> +<td>Log categories for each entry, examples: âUICHANGEâ, âOPERâ, âAPICHANGEâ.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>Local unique identifier for the Log</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td> +<td>string</td> +<td>Current user who made the change that was logged</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td>Local unique identifier for the Log entry</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</span></code></td> +<td>string</td> +<td>Log detail about what occurred</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span> + <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span> + <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span> + <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span> + <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</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/logs/:days/days</strong></p> +<blockquote> +<div><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="27%" /> +<col width="27%" /> +<col width="46%" /> +</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">days</span></code></td> +<td>yes</td> +<td>Number of days.</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">ticketNum</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td> +<td>string</td> +<td> </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">user</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</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 class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span> + <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span> + <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span> + <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span> + <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</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/logs/newcount</strong></p> +<blockquote> +<div><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="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">newLogcount</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 class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"newLogcount"</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> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="configfiles_ats.html" class="btn btn-neutral float-right" title="Config Files and Config File Metadata">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="cdn.html" class="btn btn-neutral" title="CDN"><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> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/configfiles_ats.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/configfiles_ats.html b/docs/master/api/v12/configfiles_ats.html new file mode 100644 index 0000000..9438d5f --- /dev/null +++ b/docs/master/api/v12/configfiles_ats.html @@ -0,0 +1,489 @@ + + + + +<!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>Config Files and Config File Metadata — 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" href="deliveryservice.html"/> + <link rel="prev" title="Change Logs" href="changelog.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li> + + <li><a href="../index.html">APIs</a> »</li> + + <li><a href="index.html">API 1.2 Reference</a> »</li> + + <li>Config Files and Config File Metadata</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/configfiles_ats.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.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="config-files-and-config-file-metadata"> +<span id="to-api-v12-configfiles-ats"></span><h1>Config Files and Config File Metadata<a class="headerlink" href="#config-files-and-config-file-metadata" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-servers-hostname-configfiles-ats"> +<span id="to-api-v12-configfiles-ats-route"></span><h2>/api/1.2/servers/:hostname/configfiles/ats<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/servers/:hostname/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> +<table border="1" class="docutils"> +<colgroup> +<col width="19%" /> +<col width="8%" /> +<col width="73%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head"> </th> +<th class="head"> </th> +<th class="head">Info Section</th> +</tr> +<tr class="row-even"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<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 profile assigned to the cache.</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 profile assigned to the cache.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">toRevProxyUrl</span></code></td> +<td>string</td> +<td>The configured reverse proxy cache for configfile requests.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">toURL</span></code></td> +<td>string</td> +<td>The configured URL for Traffic Ops.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverIpv4</span></code></td> +<td>string</td> +<td>The configured IP address of the cache.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverName</span></code></td> +<td>string</td> +<td>The cacheâs short form hostname.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td> +<td>int</td> +<td>The cacheâs Traffic Ops ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td> +<td>int</td> +<td>The ID of the cacheâs assigned CDN.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td> +<td>string</td> +<td>The name of the cacheâs assigned CDN.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverTcpPort</span></code></td> +<td>int</td> +<td>The configured port of the serverâs used by ATS.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fnameOnDisk</span></code></td> +<td>string</td> +<td>The filename of the configuration file as stored on the cache.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">location</span></code></td> +<td>string</td> +<td>The directory location of the configuration file as stored on the cache.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">apiUri</span></code></td> +<td>string</td> +<td>The path to generate the configuration file from Traffic Ops.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">scope</span></code></td> +<td>string</td> +<td>The scope of the configuration file.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"info"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">278</span><span class="p">,</span> + <span class="s2">"toRevProxyUrl"</span><span class="p">:</span> <span class="s2">"https://to.example.com:81"</span><span class="p">,</span> + <span class="s2">"toUrl"</span><span class="p">:</span> <span class="s2">"https://to.example.com/"</span><span class="p">,</span> + <span class="s2">"serverIpv4"</span><span class="p">:</span> <span class="s2">"192.168.1.5"</span><span class="p">,</span> + <span class="s2">"serverTcpPort"</span><span class="p">:</span> <span class="mi">80</span><span class="p">,</span> + <span class="s2">"serverName"</span><span class="p">:</span> <span class="s2">"cache-ats-01"</span><span class="p">,</span> + <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">1</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">"serverId"</span><span class="p">:</span> <span class="mi">21</span><span class="p">,</span> + <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"EDGE_CDN_1_EXAMPLE"</span> + <span class="p">},</span> + <span class="s2">"configFiles"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"remap.config"</span><span class="p">,</span> + <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span> + <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config"</span><span class="p">,</span> + <span class="s2">"scope"</span><span class="p">:</span> <span class="s2">"profiles"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"ssl_multicert.config"</span><span class="p">,</span> + <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span> + <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config"</span><span class="p">,</span> + <span class="s2">"scope"</span><span class="p">:</span> <span class="s2">"cdns"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"parent.config"</span><span class="p">,</span> + <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span> + <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +<div class="section" id="api-1-2-servers-hostname-configfiles-ats-configfile"> +<h2>/api/1.2/servers/:hostname/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2> +<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 notranslate"><div class="highlight"><pre><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">"error"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the profiles route."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +<div class="section" id="api-1-2-profiles-profile-name-configfiles-ats-configfile"> +<h2>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-profiles-profile-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2> +<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 notranslate"><div class="highlight"><pre><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">"error"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the cdns route."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +<div class="section" id="api-1-2-cdns-cdn-name-configfiles-ats-configfile"> +<h2>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-cdns-cdn-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2> +<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 notranslate"><div class="highlight"><pre><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">"error"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the servers route."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="deliveryservice.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <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> \ No newline at end of file