http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html new file mode 100644 index 0000000..911b7b6 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_regex.html @@ -0,0 +1,822 @@ + + +<!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>Delivery Service Regexes — Traffic Control 1.8-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../../../genindex.html"/> + <link rel="search" title="Search" href="../../../search.html"/> + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> + <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> + <link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/> + <link rel="prev" title="Delivery Service" href="deliveryservice.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_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 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_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> + + <li><a href="../../index.html">Developer’s Guide</a> »</li> + + <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Delivery Service Regexes</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice_regex.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="delivery-service-regexes"> +<span id="to-api-v12-ds-regexes"></span><h1>Delivery Service Regexes<a class="headerlink" href="#delivery-service-regexes" title="Permalink to this headline">¶</a></h1> +<p id="to-api-v12-ds-regexes-route"><strong>GET /api/1.2/deliveryservices_regexes</strong></p> +<blockquote> +<div><p>Retrieves regexes for all delivery services.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Oper</p> +<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"><span class="pre">dsName</span></code></td> +<td>array</td> +<td>Delivery service name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexes</span></code></td> +<td>array</td> +<td>An array of regexes for the delivery service.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>type</span></code></td> +<td>string</td> +<td>The regex type.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>pattern</span></code></td> +<td>string</td> +<td>The regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><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">"dsName"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span> + <span class="s2">"regexes"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</span> + <span class="p">}</span> + <span class="p">]</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/deliveryservices/{:dsId}/regexes</strong></p> +<blockquote> +<div><p>Retrieves regexes for a specific delivery service.</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="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"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service 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"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">853</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</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/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Retrieves a regex for a specific delivery service.</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="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"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex 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"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</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/deliveryservices/{:dsId}/regexes</strong></p> +<blockquote> +<div><p>Create a regex for a delivery service.</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="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"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="14%" /> +<col width="64%" /> +</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">pattern</span></code></td> +<td>yes</td> +<td>Regex pattern.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</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="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"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><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="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</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">"Delivery service regex creation 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>PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Update a regex for a delivery service.</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="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"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex id.</td> +</tr> +</tbody> +</table> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="14%" /> +<col width="64%" /> +</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">pattern</span></code></td> +<td>yes</td> +<td>Regex pattern.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>yes</td> +<td>Regex type ID.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</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="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"><span class="pre">id</span></code></td> +<td>string</td> +<td>Delivery service regex ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td>Delivery service regex type ID.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeName</span></code></td> +<td>string</td> +<td>Delivery service regex type name.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pattern</span></code></td> +<td>string</td> +<td>Delivery service regex pattern.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">setNumber</span></code></td> +<td>string</td> +<td>The order in which the regex is evaluated for the delivery service.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><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="mi">852</span><span class="p">,</span> + <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> + <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> + <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span> + <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</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">"Delivery service regex 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>DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p> +<blockquote> +<div><p>Delete delivery service regex.</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="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"><span class="pre">dsId</span></code></td> +<td>yes</td> +<td>Delivery service id.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Delivery service regex id.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<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">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><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"><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"><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">"Delivery service regex delete 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> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><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:'1.8-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html index ae68096..2a4a587 100644 --- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html +++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html @@ -39,7 +39,7 @@ <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> <link rel="next" title="Divisions" href="division.html"/> - <link rel="prev" title="Delivery Service" href="deliveryservice.html"/> + <link rel="prev" title="Delivery Service Regexes" href="deliveryservice_regex.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -183,7 +183,7 @@ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -218,15 +218,15 @@ </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">metricType</span></code></td> <td>yes</td> -<td>The metric type (valid metric types: âkbpsâ, âout_bytesâ, âstatus_4xxâ, âstatus_5xxâ, tps_totalâ, âtps_2xxâ,âtps_3xxâ, âtps_4xxâ, âtps_5xxâ)</td> +<td>The metric type (valid metric types: ‘kbps’, ‘out_bytes’, ‘status_4xx’, ‘status_5xx’, tps_total’, ‘tps_2xx’,’tps_3xx’, ‘tps_4xx’, ‘tps_5xx’)</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">startDate</span></code></td> <td>yes</td> -<td>The begin date (Formatted as ISO8601, for example: â2015-08-11T12:30:00-06:00â)</td> +<td>The begin date (Formatted as ISO8601, for example: ‘2015-08-11T12:30:00-06:00’)</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">endDate</span></code></td> <td>yes</td> -<td>The end date (Formatted as ISO8601, for example: â2015-08-12T12:30:00-06:00â)</td> +<td>The end date (Formatted as ISO8601, for example: ‘2015-08-12T12:30:00-06:00’)</td> </tr> </tbody> </table> @@ -319,7 +319,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"source"</span><span class="p">:</span> <span class="s2">"TrafficStats"</span><span class="p">,</span> <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span> @@ -398,7 +398,7 @@ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/division.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/division.html b/docs/latest/development/traffic_ops_api/v12/division.html index 95c7c38..2d1feaa 100644 --- a/docs/latest/development/traffic_ops_api/v12/division.html +++ b/docs/latest/development/traffic_ops_api/v12/division.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -227,7 +227,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><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">"1"</span> @@ -282,7 +282,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><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">"1"</span> @@ -344,7 +344,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span> <span class="p">}</span> </pre></div> @@ -384,7 +384,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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> @@ -429,7 +429,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span> <span class="p">}</span> </pre></div> @@ -465,7 +465,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span> <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'4'</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/federation.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/federation.html b/docs/latest/development/traffic_ops_api/v12/federation.html index af3c2b4..ec70272 100644 --- a/docs/latest/development/traffic_ops_api/v12/federation.html +++ b/docs/latest/development/traffic_ops_api/v12/federation.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -195,7 +195,7 @@ <span id="to-api-v12-federation-route"></span><h2>/api/1.2/federations<a class="headerlink" href="#api-1-2-federations" title="Permalink to this headline">¶</a></h2> <p><strong>GET /api/1.2/federations.json</strong></p> <blockquote> -<div><p>Retrieves a list of federations for a userâs delivery service(s).</p> +<div><p>Retrieves a list of federations for a user’s delivery service(s).</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: Federation</p> <p><strong>Response Properties</strong></p> @@ -227,7 +227,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"mappings"</span><span class="p">:</span> <span class="p">[</span> @@ -278,7 +278,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> @@ -301,7 +301,7 @@ </div> <p><strong>DELETE /api/1.2/federations.json</strong></p> <blockquote> -<div><p>Deletes <strong>all</strong> federations associated with a userâs delivery service(s).</p> +<div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s).</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: Federation</p> </div></blockquote> @@ -310,7 +310,7 @@ </div> <p><strong>PUT /api/1.2/federations.json</strong></p> <blockquote> -<div><p>Deletes <strong>all</strong> federations associated with a userâs delivery service(s) then adds the new federations.</p> +<div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s) then adds the new federations.</p> <p>Authentication Required: Yes</p> <p>Role(s) Required: Federation</p> <p><strong>Request Properties</strong></p> @@ -342,7 +342,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/hwinfo.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/hwinfo.html b/docs/latest/development/traffic_ops_api/v12/hwinfo.html index c4cf1c0..9fedbb5 100644 --- a/docs/latest/development/traffic_ops_api/v12/hwinfo.html +++ b/docs/latest/development/traffic_ops_api/v12/hwinfo.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -213,11 +213,11 @@ <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal"><span class="pre">serverId</span></code></td> <td>string</td> -<td>Local unique identifier for this specific serverâs hardware info</td> +<td>Local unique identifier for this specific server’s hardware info</td> </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">serverHostName</span></code></td> <td>string</td> -<td>Hostname for this specific serverâs hardware info</td> +<td>Hostname for this specific server’s hardware info</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> <td>string</td> @@ -225,16 +225,16 @@ </tr> <tr class="row-odd"><td><code class="docutils literal"><span class="pre">val</span></code></td> <td>string</td> -<td>Freeform value used to track anything about a serverâs hardware info</td> +<td>Freeform value used to track anything about a server’s hardware info</td> </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>Freeform description for this specific serverâs hardware info</td> +<td>Freeform description for this specific server’s hardware info</td> </tr> </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/influxdb.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/influxdb.html b/docs/latest/development/traffic_ops_api/v12/influxdb.html index 0dcc72a..73d472a 100644 --- a/docs/latest/development/traffic_ops_api/v12/influxdb.html +++ b/docs/latest/development/traffic_ops_api/v12/influxdb.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -219,7 +219,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"aaData"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="s2">"0"</span><span class="p">,</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/parameter.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/parameter.html b/docs/latest/development/traffic_ops_api/v12/parameter.html index 851034c..5251fdc 100644 --- a/docs/latest/development/traffic_ops_api/v12/parameter.html +++ b/docs/latest/development/traffic_ops_api/v12/parameter.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -234,7 +234,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> @@ -306,7 +306,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> @@ -324,6 +324,84 @@ <div class="line-block"> <div class="line"><br /></div> </div> +<p><strong>GET /api/1.2/parameters/:id/profiles</strong></p> +<blockquote> +<div><blockquote> +<div><p>Retrieves all profiles assigned to the parameter.</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="19%" /> +<col width="13%" /> +<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"><span class="pre">id</span></code></td> +<td>yes</td> +<td>Parameter ID.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="10%" /> +<col width="68%" /> +</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">lastUpdated</span></code></td> +<td>array</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>The name for the profile</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>Primary key</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td>The description for the profile</td> +</tr> +</tbody> +</table> +</div></blockquote> +</div></blockquote> +<p><strong>Response Example</strong></p> +<div class="highlight-default"><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-10-08 19:34:45"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</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/profiles/:id/parameters</strong></p> <blockquote> <div><p>Authentication Required: Yes</p> @@ -385,7 +463,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> @@ -477,7 +555,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span> @@ -637,46 +715,38 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Request Example</strong></p> -<ol class="arabic simple"> -<li>single parameter format exampe:</li> -</ol> -<blockquote> -<div><dl class="docutils"> -<dt>{</dt> -<dd>ânameâ:âparam1â, -âconfigFileâ:âconfigFile1â -âvalueâ:âvalue1â, -âsecureâ:0,</dd> -</dl> -<p>}</p> -</div></blockquote> -<ol class="arabic simple" start="2"> -<li>array format example:</li> +<ol class="arabic"> +<li><p class="first">single parameter format example:</p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span> +<span class="p">}</span> +</pre></div> +</div> +</li> +<li><p class="first">array format example:</p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">[</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span> + <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span> + <span class="p">}</span> +<span class="p">]</span> +</pre></div> +</div> +</li> </ol> -<blockquote> -<div><dl class="docutils"> -<dt>[</dt> -<dd><dl class="first docutils"> -<dt>{</dt> -<dd>ânameâ:âparam1â, -âconfigFileâ:âconfigFile1â -âvalueâ:âvalue1â, -âsecureâ:0,</dd> -</dl> -<p>}, -{</p> -<blockquote> -<div>ânameâ:âparam2â, -âconfigFileâ:âconfigFile2â -âvalueâ:âvalue2â, -âsecureâ:1,</div></blockquote> -<p class="last">}</p> -</dd> -</dl> -<p>]</p> -</div></blockquote> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><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">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> @@ -705,7 +775,7 @@ The request route parameters accept 2 formats, both single paramter and paramete <dt><strong>PUT /api/1.2/parameters/{:id}</strong></dt> <dd><p class="first">Edit parameter.</p> <p>Authentication Required: Yes</p> -<p>Role(s) Required: if the parameterâs secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.</p> +<p>Role(s) Required: if the parameter’s secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.</p> <p><strong>Request Parameters</strong></p> <table border="1" class="docutils"> <colgroup> @@ -801,16 +871,16 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> - <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> <span class="p">}</span> </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> @@ -885,16 +955,14 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span> - -<span class="p">{</span> +<div class="last highlight-default"><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">"Parameter was successfully deleted."</span> <span class="p">}</span> - <span class="p">],</span> + <span class="p">]</span> <span class="p">}</span> </pre></div> </div> @@ -973,15 +1041,15 @@ The request route parameters accept 2 formats, both single paramter and paramete </tbody> </table> <p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span> - <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span> - <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> + <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span> + <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span> <span class="p">}</span> </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span> <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/phys_location.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/phys_location.html b/docs/latest/development/traffic_ops_api/v12/phys_location.html index f5466ae..2e9f010 100644 --- a/docs/latest/development/traffic_ops_api/v12/phys_location.html +++ b/docs/latest/development/traffic_ops_api/v12/phys_location.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -197,6 +197,26 @@ <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="20%" /> +<col width="14%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">region</span></code></td> +<td>no</td> +<td>Filter by Region ID.</td> +</tr> +</tbody> +</table> <p><strong>Response Properties</strong></p> <table border="1" class="docutils"> <colgroup> @@ -270,7 +290,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> @@ -337,7 +357,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> @@ -450,7 +470,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> @@ -562,7 +582,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> @@ -656,7 +676,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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> @@ -771,7 +791,7 @@ </tbody> </table> <p><strong>Request Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span> <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span> <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span> @@ -857,7 +877,7 @@ </tbody> </table> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span> +<div class="highlight-default"><div class="highlight"><pre> <span class="p">{</span> <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span> <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/development/traffic_ops_api/v12/profile.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/profile.html b/docs/latest/development/traffic_ops_api/v12/profile.html index 373230e..7923432 100644 --- a/docs/latest/development/traffic_ops_api/v12/profile.html +++ b/docs/latest/development/traffic_ops_api/v12/profile.html @@ -61,7 +61,7 @@ - <img src="../../../_static/tc_logo.png" class="logo" /> + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administratorâs Guide</a><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> @@ -120,7 +120,7 @@ </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-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current"> <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> @@ -164,7 +164,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> - <li><a href="../../index.html">Developerâs Guide</a> »</li> + <li><a href="../../index.html">Developer’s Guide</a> »</li> <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> @@ -252,7 +252,7 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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-10-08 19:34:45"</span><span class="p">,</span> @@ -295,7 +295,7 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span> @@ -367,7 +367,7 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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-10-08 19:34:45"</span><span class="p">,</span> @@ -417,7 +417,7 @@ </div></blockquote> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span> <span class="p">}</span> @@ -460,7 +460,7 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"66"</span><span class="p">,</span> @@ -538,14 +538,14 @@ </tr> <tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> <td>string</td> -<td>new profileâs description (copied)</td> +<td>new profile’s description (copied)</td> </tr> </tbody> </table> </div></blockquote> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="last highlight-default"><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">"66"</span><span class="p">,</span> @@ -617,7 +617,7 @@ </div></blockquote> </div></blockquote> <p><strong>Request Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span>{ +<div class="highlight-default"><div class="highlight"><pre>{ "name": "CCR_UPDATE", "description": "CCR_UPDATE description" } @@ -646,7 +646,7 @@ </pre></div> </div> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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">"219"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_UPDATE"</span><span class="p">,</span> @@ -725,7 +725,7 @@ </table> </div></blockquote> <p><strong>Response Example</strong></p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<div class="highlight-default"><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>
