http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/tenant.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/tenant.html b/docs/latest/development/traffic_ops_api/v12/tenant.html new file mode 100644 index 0000000..329314a --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/tenant.html @@ -0,0 +1,621 @@ + + +<!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.1-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> + <link rel="up" title="Traffic Ops" href="../../traffic_ops.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/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.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> + + <li><a href="../../index.html">Developer’s Guide</a> »</li> + + <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Tenants</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/tenant.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"><span class="pre">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"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"><span class="pre">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"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"><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"><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"><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"><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"><div class="highlight"><pre><span></span><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"><span class="pre">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"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"><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"><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"><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"><div class="highlight"><pre><span></span><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"><span class="pre">id</span></code></td> +<td>int</td> +<td>Tenant id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>Tenant name</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../../', + VERSION:'2.1-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' + }; + </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/42d25dc5/docs/latest/development/traffic_ops_api/v12/to_extension.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/to_extension.html b/docs/latest/development/traffic_ops_api/v12/to_extension.html index 4679038..00e8217 100644 --- a/docs/latest/development/traffic_ops_api/v12/to_extension.html +++ b/docs/latest/development/traffic_ops_api/v12/to_extension.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>TO Extensions — Traffic Control master documentation </title> + <title>TO Extensions — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Types" href="type.html"/> - <link rel="prev" title="System" href="system.html"/> + <link rel="prev" title="Tenants" href="tenant.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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/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.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -180,7 +185,7 @@ <a href="type.html" class="btn btn-neutral float-right" title="Types">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> + <a href="tenant.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -251,34 +256,34 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "response": [ - { - script_file: "ping", - version: "1.0.0", - name: "ILO_PING", - description: null, - info_url: "http://foo.com/bar.html", - additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }", - isactive: "1", - id: "1", - type: "CHECK_EXTENSION_BOOL", - servercheck_short_name: "ILO" - }, - { - script_file: "ping", - version: "1.0.0", - name: "10G_PING", - description: null, - info_url: "http://foo.com/bar.html", - additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }", - isactive: "1", - id: "2", - type: "CHECK_EXTENSION_BOOL", - servercheck_short_name: "10G" - } - ], -} +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="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"> @@ -342,17 +347,17 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre>{ - "name": "ILO_PING", - "version": "1.0.0", - "info_url": "http://foo.com/bar.html", - "script_file": "ping", - "isactive": "1", - "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}", - "description": null, - "servercheck_short_name": "ILO" - "type": "CHECK_EXTENSION_BOOL", -} +<div class="highlight-default"><div class="highlight"><pre><span></span><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> @@ -389,11 +394,11 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</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> @@ -457,11 +462,11 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> - <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</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> @@ -483,7 +488,7 @@ <a href="type.html" class="btn btn-neutral float-right" title="Types">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> + <a href="tenant.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -512,10 +517,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/topology.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/topology.html b/docs/latest/development/traffic_ops_api/v12/topology.html index a17acfe..a0c04c1 100644 --- a/docs/latest/development/traffic_ops_api/v12/topology.html +++ b/docs/latest/development/traffic_ops_api/v12/topology.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Snapshot CRConfig — Traffic Control master documentation </title> + <title>Snapshot CRConfig — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Traffic Portal" href="../../traffic_portal.html"/> <link rel="prev" title="Users" href="user.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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/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.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -190,10 +195,174 @@ <span id="to-api-v12-topology"></span><h1>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">¶</a></h1> <div class="section" id="api-1-2-snapshot-cdn-name"> <span id="to-api-v12-topology-route"></span><h2>/api/1.2/snapshot/{:cdn_name}<a class="headerlink" href="#api-1-2-snapshot-cdn-name" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/cdns/{:cdn_name}/snapshot</strong></p> +<blockquote> +<div><p>Retrieves the CURRENT snapshot for a CDN which doesn’t necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Operations</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="14%" /> +<col width="63%" /> +</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"><span class="pre">cdn_name</span></code></td> +<td>yes</td> +<td>CDN name.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="7%" /> +<col width="72%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">config</span></code></td> +<td>hash</td> +<td>General CDN configuration settings.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">contentRouters</span></code></td> +<td>hash</td> +<td>A list of Traffic Routers.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">contentServers</span></code></td> +<td>hash</td> +<td>A list of Traffic Servers and the delivery services associated with each.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td> +<td>hash</td> +<td>A list of delivery services.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeLocations</span></code></td> +<td>hash</td> +<td>A list of cache groups.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td> +<td>hash</td> +<td>Snapshot properties.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="p">},</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/cdns/{:cdn_name}/snapshot/new</strong></p> +<blockquote> +<div><p>Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Operations</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="14%" /> +<col width="63%" /> +</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"><span class="pre">cdn_name</span></code></td> +<td>yes</td> +<td>CDN name.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="7%" /> +<col width="72%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">config</span></code></td> +<td>hash</td> +<td>General CDN configuration settings.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">contentRouters</span></code></td> +<td>hash</td> +<td>A list of Traffic Routers.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">contentServers</span></code></td> +<td>hash</td> +<td>A list of Traffic Servers and the delivery services associated with each.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryServices</span></code></td> +<td>hash</td> +<td>A list of delivery services.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeLocations</span></code></td> +<td>hash</td> +<td>A list of cache groups.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td> +<td>hash</td> +<td>Snapshot properties.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span> + <span class="p">},</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> <p><strong>PUT /api/1.2/snapshot/{:cdn_name}</strong></p> <blockquote> <div><p>Authentication Required: Yes</p> -<p>Role(s) Required: admin or oper</p> +<p>Role(s) Required: Admin or Operations</p> <p><strong>Request Route Parameters</strong></p> <table border="1" class="docutils"> <colgroup> @@ -235,8 +404,8 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="s">"SUCCESS"</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"SUCCESS"</span> <span class="p">}</span> </pre></div> </div> @@ -285,10 +454,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/type.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/type.html b/docs/latest/development/traffic_ops_api/v12/type.html index 94e0098..bd21c50 100644 --- a/docs/latest/development/traffic_ops_api/v12/type.html +++ b/docs/latest/development/traffic_ops_api/v12/type.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Types — Traffic Control master documentation </title> + <title>Types — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Users" href="user.html"/> <link rel="prev" title="TO Extensions" href="to_extension.html"/> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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/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.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> <li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../../../index.html">Traffic Control master</a> »</li> + <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="../../index.html">Developer’s Guide</a> »</li> @@ -251,14 +256,14 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span><span class="p">,</span> - <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span> + <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -293,19 +298,19 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span> <span class="p">},</span> <span class="p">{</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span> <span class="p">}</span> <span class="p">],</span> <span class="p">}</span> @@ -373,14 +378,14 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> - <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> - <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span> - <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span> - <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span><span class="p">,</span> - <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span> - <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span> + <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> @@ -431,10 +436,11 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../../../_static/jquery.js"></script>
