You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:10:52 UTC
[04/76] [abbrv] [partial] incubator-trafficcontrol-website git
commit: add 1.8.0 docs
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ee296175/docs/1.8.0/development/traffic_ops_api/v12/parameter.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/development/traffic_ops_api/v12/parameter.html b/docs/1.8.0/development/traffic_ops_api/v12/parameter.html
new file mode 100644
index 0000000..2e73b3c
--- /dev/null
+++ b/docs/1.8.0/development/traffic_ops_api/v12/parameter.html
@@ -0,0 +1,1065 @@
+
+
+<!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 1.8.0 documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
+ <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
+ <link rel="next" title="Physical Location" href="phys_location.html"/>
+ <link rel="prev" title="Hardware Info" href="hwinfo.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.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.0</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>Parameter</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/parameter.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="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><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>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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"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/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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"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/profiles/:id/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"><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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"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"><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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><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"><span class="pre">>value</span></code></td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><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 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>
+<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-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1139"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value2"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param2"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1140"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"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"><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"><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"><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"><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"><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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre>{
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+}
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"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"><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"><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>
+<tr class="row-odd"><td><code class="docutils literal"><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-python"><div class="highlight"><pre>Response Example:
+
+{
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ],
+}
+</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"><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"><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"><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"><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"><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"><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"><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"><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-python"><div class="highlight"><pre>{
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+}
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"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="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><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.0',
+ 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/ee296175/docs/1.8.0/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/development/traffic_ops_api/v12/phys_location.html b/docs/1.8.0/development/traffic_ops_api/v12/phys_location.html
new file mode 100644
index 0000000..d6ea8de
--- /dev/null
+++ b/docs/1.8.0/development/traffic_ops_api/v12/phys_location.html
@@ -0,0 +1,948 @@
+
+
+<!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>Physical Location — Traffic Control 1.8.0 documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
+ <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
+ <link rel="next" title="Profiles" href="profile.html"/>
+ <link rel="prev" title="Parameter" href="parameter.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.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.0</a> »</li>
+
+ <li><a href="../../index.html">Developer’s Guide</a> »</li>
+
+ <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li>
+
+ <li>Physical Location</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../../_sources/development/traffic_ops_api/v12/phys_location.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="physical-location">
+<span id="to-api-v12-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">�</a></h1>
+<div class="section" id="api-1-2-phys-locations">
+<span id="to-api-v12-phys-loc-route"></span><h2>/api/1.2/phys_locations<a class="headerlink" href="#api-1-2-phys-locations" title="Permalink to this headline">�</a></h2>
+<p><strong>GET /api/1.2/phys_locations</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</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/phys_locations/trimmed.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="11%" />
+<col width="61%" />
+</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">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</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/phys_locations/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</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>PUT /api/1.2/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">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">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"regionId"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Physical location update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</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/regions/:region_name/phys_locations</strong></dt>
+<dd><p class="first">Create physical location.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>region_name: the name of the region to create physical location into.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="16%" />
+<col width="56%" />
+</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_name</span></code></td>
+<td>yes</td>
+<td>The name of the physical location</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</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">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span>
+ <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
+ <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id of the physical location created.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">regionName</span></code></td>
+<td>string</td>
+<td>The region name the physical location belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+}
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><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.0',
+ 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