http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/api_capability.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/api_capability.html b/docs/master/api/v12/api_capability.html new file mode 100644 index 0000000..e538f30 --- /dev/null +++ b/docs/master/api/v12/api_capability.html @@ -0,0 +1,799 @@ + + + + +<!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>API-Capabilities — 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="ASN" href="asn.html"/> + <link rel="prev" title="API 1.2 Reference" href="index.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administratorâs Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/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>API-Capabilities</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/api_capability.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="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.2 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="api-capabilities"> +<span id="to-api-v12-api-capability"></span><h1>API-Capabilities<a class="headerlink" href="#api-capabilities" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-api-capabilities"> +<span id="to-api-v12-api-capability-route"></span><h2>/api/1.2/api_capabilities<a class="headerlink" href="#api-1-2-api-capabilities" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/api_capabilities</strong></p> +<blockquote> +<div><p>Get all API-capability mappings.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="14%" /> +<col width="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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">capability</span></code></td> +<td>no</td> +<td>string</td> +<td>Capability name.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name.</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> +</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="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns/*"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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/api_capabilities/:id</strong></p> +<blockquote> +<div><p>Get an API-capability mapping by id.</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="19%" /> +<col width="15%" /> +<col width="10%" /> +<col width="55%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>int</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name.</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> +</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="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</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/api_capabilities</strong></p> +<blockquote> +<div><p>Create an API-capability mapping.</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="19%" /> +<col width="12%" /> +<col width="10%" /> +<col width="60%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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">httpMethod</span></code></td> +<td>yes</td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td> +<td>yes</td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td> +<td>yes</td> +<td>string</td> +<td>Capability name</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">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="10%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> +<td>hash</td> +<td>The details of the creation, if success.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>httpMethod</span></code></td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>capability</span></code></td> +<td>string</td> +<td>Capability name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">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">"response"</span><span class="p">:{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span> + <span class="p">},</span> + <span class="s2">"alerts"</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">"API-capability mapping was created."</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/api_capabilities/{:id}</strong></p> +<blockquote> +<div><p>Edit an API-capability mapping.</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="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>string</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="10%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td> +<td>string</td> +<td>Capability name</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">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="10%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> +<td>hash</td> +<td>The details of the creation, if success.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td> +<td>int</td> +<td>Mapping id.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>httpMethod</span></code></td> +<td>enum</td> +<td>One of: âGETâ, âPOSTâ, âPUTâ, âPATCHâ, âDELETEâ.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>route</span></code></td> +<td>string</td> +<td>API route.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>capability</span></code></td> +<td>string</td> +<td>Capability name</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">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">"response"</span><span class="p">:{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span> + <span class="s2">"route"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span> + <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span> + <span class="p">},</span> + <span class="s2">"alerts"</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">"API-capability mapping was updated."</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>DELETE /api/1.2/api_capabilities/{:id}</strong></p> +<blockquote> +<div><p>Delete a capability.</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="11%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</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>yes</td> +<td>string</td> +<td>Mapping id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="13%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">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">"API-capability mapping deleted."</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="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="index.html" class="btn btn-neutral" title="API 1.2 Reference"><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/asn.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/asn.html b/docs/master/api/v12/asn.html new file mode 100644 index 0000000..22822be --- /dev/null +++ b/docs/master/api/v12/asn.html @@ -0,0 +1,587 @@ + + + + +<!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>ASN — 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="Cache" href="cache.html"/> + <link rel="prev" title="API-Capabilities" href="api_capability.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>ASN</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/asn.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="cache.html" class="btn btn-neutral float-right" title="Cache">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="asn"> +<span id="to-api-v12-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-asns"> +<span id="to-api-v12-asns-route"></span><h2>/api/1.2/asns<a class="headerlink" href="#api-1-2-asns" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/asns</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="28%" /> +<col width="13%" /> +<col width="59%" /> +</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">cachegroup</span></code></td> +<td>no</td> +<td>Filter ASNs by cache group ID</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td>Local unique identifier for the ASN</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td> +<td>string</td> +<td>Autonomous System Numbers per APNIC for identifying a service provider.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td> +<td>string</td> +<td>Related cachegroup name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td> +<td>string</td> +<td>Related cachegroup id</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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</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/asns/:id</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="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>yes</td> +<td>ASN id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="8%" /> +<col width="74%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td>Local unique identifier for the ASN</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td> +<td>string</td> +<td>Autonomous System Numbers per APNIC for identifying a service provider.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td> +<td>string</td> +<td>Related cachegroup name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td> +<td>string</td> +<td>Related cachegroup id</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">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</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/asns/{:id}</strong></p> +<blockquote> +<div><p>Allows user to edit an ASN.</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>ASN id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="11%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td> +<td>string</td> +<td>ASN</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td> +<td>string</td> +<td>The cachegroup the ASN belongs to</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">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="26%" /> +<col width="10%" /> +<col width="64%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td> +<td>hash</td> +<td>The details of the update, if success.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td> +<td>string</td> +<td>CDN name.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td> +<td>int</td> +<td>CDN id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>dnssecEnabled</span></code></td> +<td>string</td> +<td>Whether dnssec is enabled.</td> +</tr> +<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">"response"</span><span class="p">:{</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span> + <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span> + <span class="p">},</span> + <span class="s2">"alerts"</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">"cdn was updated."</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="cache.html" class="btn btn-neutral float-right" title="Cache">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><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/cache.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v12/cache.html b/docs/master/api/v12/cache.html new file mode 100644 index 0000000..4b1ce60 --- /dev/null +++ b/docs/master/api/v12/cache.html @@ -0,0 +1,386 @@ + + + + +<!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>Cache — 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="Cache Group" href="cachegroup.html"/> + <link rel="prev" title="ASN" href="asn.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>Cache</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v12/cache.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="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="cache"> +<span id="to-api-v12-cache"></span><h1>Cache<a class="headerlink" href="#cache" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-caches-stats"> +<span id="to-api-v12-cache-route"></span><h2>/api/1.2/caches/stats<a class="headerlink" href="#api-1-2-caches-stats" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/caches/stats</strong></p> +<blockquote> +<div><p>Retrieves cache stats from Traffic Monitor. Also includes rows for aggregates.</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="21%" /> +<col width="11%" /> +<col width="67%" /> +</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">profile</span></code></td> +<td>string</td> +<td>The profile of the cache.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td> +<td>string</td> +<td>The cache group of the cache.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td> +<td>string</td> +<td>The hostname of the cache.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip</span></code></td> +<td>string</td> +<td>The IP address of the cache.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td> +<td>string</td> +<td>The status of the cache.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">healthy</span></code></td> +<td>string</td> +<td>Has Traffic Monitor marked the cache as healthy or unhealthy?</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">connections</span></code></td> +<td>string</td> +<td>Cache connections</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kbps</span></code></td> +<td>string</td> +<td>Cache kbps out</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">"profile"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"ip"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span> + <span class="s2">"healthy"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"connections"</span><span class="p">:</span> <span class="mi">934424</span><span class="p">,</span> + <span class="s2">"kbps"</span><span class="p">:</span> <span class="mi">618631875</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_FOO_721-ATS621-45"</span><span class="p">,</span> + <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-nm-albuquerque"</span><span class="p">,</span> + <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foo-bar-alb-01"</span><span class="p">,</span> + <span class="s2">"ip"</span><span class="p">:</span> <span class="s2">"2.2.2.2"</span><span class="p">,</span> + <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span> + <span class="s2">"healthy"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"connections"</span><span class="p">:</span> <span class="mi">373</span><span class="p">,</span> + <span class="s2">"kbps"</span><span class="p">:</span> <span class="mi">390136</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="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="asn.html" class="btn btn-neutral" title="ASN"><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