http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v12/parameter.html
----------------------------------------------------------------------
diff --git a/docs/master/api/v12/parameter.html
b/docs/master/api/v12/parameter.html
new file mode 100644
index 0000000..6780af6
--- /dev/null
+++ b/docs/master/api/v12/parameter.html
@@ -0,0 +1,1383 @@
+
+
+
+
+<!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>Parameter — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css"
/>
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css"
type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation"
href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Physical Location" href="phys_location.html"/>
+ <link rel="prev" title="Jobs" href="job.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html"
method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation"
aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/content_delivery_networks.html">Content Delivery
Networks</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/cache_revalidation.html">Cache Control Headers and
Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../admin/index.html">Administratorâs Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/installation.html">Traffic Ops -
Installing</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default
Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops -
Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops -
Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/configuration.html">Traffic Ops -
Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops
Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_portal/installation.html">Traffic Portal
Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal -
Using</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_monitor.html">Traffic Monitor Administration
(Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_monitor_golang.html">Traffic Monitor
Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../development/index.html">Developerâs Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal"
href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal"
href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API
Routes</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal"
href="index.html">API 1.2 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Parameter</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/parameter.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="phys_location.html" class="btn btn-neutral
float-right" title="Physical Location">Next <span class="fa
fa-arrow-circle-right"></span></a>
+
+
+ <a href="job.html" class="btn btn-neutral"
title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="parameter">
+<span id="to-api-v12-parameter"></span><h1>Parameter<a class="headerlink"
href="#parameter" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-parameters">
+<span id="to-api-v12-parameters-route"></span><h2>/api/1.2/parameters<a
class="headerlink" href="#api-1-2-parameters" title="Permalink to this
headline">¶</a></h2>
+<p><strong>GET /api/1.2/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>no</td>
+<td>Filter parameters by name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">configFile</span></code></td>
+<td>no</td>
+<td>Filter parameters by config file.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to
false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">configFile</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">profiles</span></code></td>
+<td>array</td>
+<td>An array of profiles attached to this parameter.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span>
<span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span>
<span class="s2">"FooConfig.xml"</span><span class="p">,</span>
+ <span class="s2">"profiles"</span><span class="p">:</span>
<span class="p">[</span> <span class="s2">"EDGE-FOO, MID-FOO"</span>
<span class="p">]</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span>
<span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span>
<span class="s2">"storage.config"</span><span class="p">,</span>
+ <span class="s2">"profiles"</span><span class="p">:</span>
<span class="p">[</span> <span class="s2">"EDGE-FOO, MID-FOO"</span>
<span class="p">]</span>
+
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span>
<span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"CONFIG proxy.config.proxy_name"</span><span
class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span>
<span class="s2">"records.config"</span>
+ <span class="s2">"profiles"</span><span class="p">:</span>
<span class="p">[</span> <span class="p">]</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/parameters/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: if secure of the parameter fetched is 1, require admin
role, or any valid role can access.</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter index</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to
false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span>
<span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span>
<span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span
class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span
class="p">:</span> <span class="s2">"FooConfig.xml"</span><span
class="p">,</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/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 notranslate"><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 notranslate"><span
class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">type</span></code></td>
+<td>string</td>
+<td>The type for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span
class="p">:</span> <span class="s2">"2012-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="s2">"type"</span><span class="p">:</span> <span
class="s2">"ATS_PROFILE"</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/parameters/:id/unassigned_profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Retrieves all profiles NOT 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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span
class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span
class="p">:</span> <span class="s2">"2012-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>Retrieves all parameters assigned to the profile.</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="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>yes</td>
+<td>Profile id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to
false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"FooConfig.xml"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"storage.config"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"CONFIG proxy.config.proxy_name"</span><span
class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"records.config"</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/unassigned_parameters</strong></p>
+<blockquote>
+<div><p>Retrieves all parameters NOT assigned to the profile.</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="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>yes</td>
+<td>Profile id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to
false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"FooConfig.xml"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"storage.config"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"CONFIG proxy.config.proxy_name"</span><span
class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"records.config"</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/name/:name/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>yes</td>
+<td>Profile name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to
false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"FooConfig.xml"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"storage.config"</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>
+ <span class="s2">"secure"</span><span class="p">:</span>
<span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span
class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span
class="s2">"CONFIG proxy.config.proxy_name"</span><span
class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span>
<span class="s2">"records.config"</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>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters</strong></dt>
+<dd><p class="first">Create parameters.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong>
+The request route parameters accept 2 formats, both single paramter and
parameters array formats are acceptable.</p>
+<p>single parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users.
Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p>parameters array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users.
Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="8%" />
+<col width="77%" />
+</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> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>name</span></code></td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>configFile</span></code></td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>value</span></code></td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>secure</span></code></td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users.
Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<ol class="arabic">
+<li><p class="first">single parameter format example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span
class="s2">"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 notranslate"><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>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div
class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"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="s2">"name"</span><span
class="p">:</span><span class="s2">"param1"</span><span
class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span
class="s2">"1139"</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="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="s2">"name"</span><span
class="p">:</span><span class="s2">"param2"</span><span
class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span
class="s2">"1140"</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="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<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><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">configFile</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>no</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users.
Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to
0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span
class="s2">"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="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 notranslate"><div
class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">{</span>
+ <span class="s2">"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="s2">"name"</span><span class="p">:</span><span
class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span
class="s2">"1134"</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="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>DELETE /api/1.2/parameters/{:id}</strong></dt>
+<dd><p class="first">delete parameter. If the parameter have profile
associated, can not be deleted.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper role</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>No Request Route Parameters</strong></p>
+<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 notranslate"><span
class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div
class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span>
<span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span
class="s2">"Parameter was successfully deleted."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters/validate</strong></dt>
+<dd><p class="first">Validate if the parameter exists.</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="28%" />
+<col width="17%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type | Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>yes</td>
+<td>string | parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string | parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>yes</td>
+<td>string | parameter value</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to
0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span
class="s2">"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>
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div
class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span
class="p">{</span>
+ <span class="s2">"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="s2">"name"</span><span class="p">:</span><span
class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span
class="s2">"1134"</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="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<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="phys_location.html" class="btn btn-neutral float-right"
title="Physical Location">Next <span class="fa
fa-arrow-circle-right"></span></a>
+
+
+ <a href="job.html" class="btn btn-neutral" title="Jobs"><span
class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a
href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a
href="https://readthedocs.org";>Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note"
aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a
href="http://www.readthedocs.org";>Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript"
src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
