http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/system.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/system.html b/docs/master/api/v12/system.html new file mode 100644 index 0000000..1b0d4b2 --- /dev/null +++ b/docs/master/api/v12/system.html @@ -0,0 +1,383 @@ + + + + +<!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>System — 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="Tenants" href="tenant.html"/> + <link rel="prev" title="Steering Targets" href="steering_target.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>System</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/system.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="tenant.html" class="btn btn-neutral float-right" title="Tenants">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="steering_target.html" class="btn btn-neutral" title="Steering Targets"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="system"> +<span id="to-api-v12-sys"></span><h1>System<a class="headerlink" href="#system" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-1-system"> +<span id="to-api-v12-sys-route"></span><h2>/api/1.1/system<a class="headerlink" href="#api-1-1-system" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/system/info.json</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="16%" /> +<col width="5%" /> +<col width="79%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Key</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">parameters</span></code></td> +<td>hash</td> +<td>This is a hash with the parameter names that describe the Traffic Ops installation as keys. +These are all the parameters in the <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code> profile.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.toolname</span></code></td> +<td>string</td> +<td>The name of the Traffic Ops tool. Usually âTraffic Opsâ. Used in the About screen and in the comments headers of the files generated +(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.instance_name</span></code></td> +<td>string</td> +<td>The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_rtr_fwd_proxy</span></code></td> +<td>string</td> +<td>When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. +This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting +this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to +set this parameter on a production system.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.url</span></code></td> +<td>string</td> +<td>The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated +(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_mon_fwd_proxy</span></code></td> +<td>string</td> +<td>When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. +This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting +this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to +set this parameter on a production system.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.logourl</span></code></td> +<td>string</td> +<td>This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.infourl</span></code></td> +<td>string</td> +<td>This is the âfor more information go hereâ URL, which is visible in the About page.</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">"parameters"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span> + <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span> + <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span> + <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span> + <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span> + <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span> + <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</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="tenant.html" class="btn btn-neutral float-right" title="Tenants">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="steering_target.html" class="btn btn-neutral" title="Steering Targets"><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/tenant.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/tenant.html b/docs/master/api/v12/tenant.html new file mode 100644 index 0000000..13b1882 --- /dev/null +++ b/docs/master/api/v12/tenant.html @@ -0,0 +1,656 @@ + + + + +<!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>Tenants — 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="TO Extensions" href="to_extension.html"/> + <link rel="prev" title="System" href="system.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>Tenants</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/tenant.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="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="tenants"> +<span id="to-api-v12-tenant"></span><h1>Tenants<a class="headerlink" href="#tenants" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-tenants"> +<span id="to-api-v12-tenant-route"></span><h2>/api/1.2/tenants<a class="headerlink" href="#api-1-2-tenants" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/tenants</strong></p> +<blockquote> +<div><p>Get all tenants.</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="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">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>bool</td> +<td>Active or inactive</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>int</td> +<td>Parent tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td> +<td>string</td> +<td>Parent tenant name</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">"id"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"root"</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">"parentId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"parentName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tenant-a"</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">"parentId"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</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/tenants/:id</strong></p> +<blockquote> +<div><p>Get a tenant by ID.</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="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">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>bool</td> +<td>Active or inactive</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>int</td> +<td>Parent tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td> +<td>string</td> +<td>Parent tenant name</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">"id"</span><span class="p">:</span> <span class="mi">2</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tenant-a"</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">"parentId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</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/tenants/:id</strong></p> +<blockquote> +<div><p>Update a tenant.</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="25%" /> +<col width="13%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</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">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="35%" /> +<col width="18%" /> +<col width="47%" /> +</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><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>yes</td> +<td>The name of the tenant</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>yes</td> +<td>True or false</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>yes</td> +<td>Parent tenant</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my-tenant"</span> + <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span> + <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">1</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="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">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>bool</td> +<td>Active or inactive</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>int</td> +<td>Parent tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td> +<td>string</td> +<td>Parent tenant name</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">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my-tenant"</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">"parentId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</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">"Tenant update was successful."</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/tenants</strong></p> +<blockquote> +<div><p>Create a tenant.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: admin or oper</p> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="35%" /> +<col width="18%" /> +<col width="47%" /> +</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><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>yes</td> +<td>The name of the tenant</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>no</td> +<td>Defaults to false</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>yes</td> +<td>Parent tenant</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"your-tenant"</span> + <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">2</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="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">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td> +<td>bool</td> +<td>Active or inactive</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td> +<td>int</td> +<td>Parent tenant ID</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td> +<td>string</td> +<td>Parent tenant name</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">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"your-tenant"</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">"parentId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> + <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"my-tenant"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</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">"Tenant create was successful."</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="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="system.html" class="btn btn-neutral" title="System"><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/to_extension.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/to_extension.html b/docs/master/api/v12/to_extension.html new file mode 100644 index 0000000..84e34d5 --- /dev/null +++ b/docs/master/api/v12/to_extension.html @@ -0,0 +1,583 @@ + + + + +<!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>TO Extensions — 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="Types" href="type.html"/> + <link rel="prev" title="Tenants" href="tenant.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>TO Extensions</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/to_extension.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="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="tenant.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="to-extensions"> +<span id="to-api-v12-ext"></span><h1>TO Extensions<a class="headerlink" href="#to-extensions" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-to-extensions"> +<span id="to-api-v12-ext-route"></span><h2>/api/1.2/to_extensions<a class="headerlink" href="#api-1-2-to-extensions" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/to_extensions.json</strong></p> +<p>Retrieves the list of extensions.</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="33%" /> +<col width="10%" /> +<col width="56%" /> +</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">script_file</span></code></td> +<td>string</td> +<td> </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> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</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">servercheck_short_name</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="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span> + <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span> + <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span> + <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span> + <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }& quot;</span><span class="p">,</span> + <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span> + <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span> + <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span> + <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span> + <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span> + <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo t;</span><span class="p">,</span> + <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span> + <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.2/to_extensions</strong></p> +<blockquote> +<div><p>Creates a Traffic Ops extension.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="10%" /> +<col width="56%" /> +</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">name</span></code></td> +<td>string</td> +<td> </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> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">script_file</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</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> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span> + <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span> + <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span> + <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span> + <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</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="22%" /> +<col width="15%" /> +<col width="63%" /> +</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> +</tbody> +</table> +<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">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Check Extension loaded."</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/to_extensions/:id/delete</strong></p> +<blockquote> +<div><p>Deletes a Traffic Ops extension.</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="23%" /> +<col width="29%" /> +<col width="49%" /> +</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>TO extension id</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="15%" /> +<col width="63%" /> +</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> +</tbody> +</table> +<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">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Extension deleted."</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="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="tenant.html" class="btn btn-neutral" title="Tenants"><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
