http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v11/phys_location.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v11/phys_location.html b/docs/master/api/v11/phys_location.html new file mode 100644 index 0000000..f4c45a9 --- /dev/null +++ b/docs/master/api/v11/phys_location.html @@ -0,0 +1,989 @@ + + + + +<!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 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.1 Reference" href="index.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_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 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v12/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.1 Reference</a> »</li> + + <li>Physical Location</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v11/phys_location.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="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-v11-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-1-phys-locations"> +<span id="to-api-v11-phys-loc-route"></span><h2>/api/1.1/phys_locations<a class="headerlink" href="#api-1-1-phys-locations" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.1/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 notranslate"><span class="pre">address</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"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.1/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 notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"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.1/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 notranslate"><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 notranslate"><span class="pre">address</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"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.1/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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"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 notranslate"><span class="pre">address</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"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">"Physical location update was successful."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span> + <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span> + <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane....@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> + <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span> + <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"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.1/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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">address</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td> +<td>no</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">email</span></code></td> +<td>no</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><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-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span> + <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span> + <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span> + <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span> + <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span> + <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><span class="pre">regionId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><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 notranslate"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre> <span class="p">{</span> + <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> + <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span> + <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span> + <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span> + <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span> + <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span> + <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span> + <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span> + <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span> + <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span> + <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="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> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org";>Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'2.2-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v11/profile.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v11/profile.html b/docs/master/api/v11/profile.html new file mode 100644 index 0000000..eabb7e0 --- /dev/null +++ b/docs/master/api/v11/profile.html @@ -0,0 +1,472 @@ + + + + +<!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>Profiles — 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.1 Reference" href="index.html"/> + <link rel="next" title="Regions" href="region.html"/> + <link rel="prev" title="Physical Location" href="phys_location.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 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li> +<li class="toctree-l2"><a class="reference internal" href="../v12/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.1 Reference</a> »</li> + + <li>Profiles</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v11/profile.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="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="profiles"> +<span id="to-api-v11-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-1-profiles"> +<span id="to-api-v11-profiles-route"></span><h2>/api/1.1/profiles<a class="headerlink" href="#api-1-1-profiles" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.1/profiles</strong></p> +<blockquote> +<div><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="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> +<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.1/profiles/trimmed</strong></p> +<blockquote> +<div><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="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">name</span></code></td> +<td>string</td> +<td>The name for the profile</td> +</tr> +</tbody> +</table> +</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">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</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.1/profiles/:id</strong></p> +<blockquote> +<div><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="22%" /> +<col width="16%" /> +<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 notranslate"><span class="pre">id</span></code></td> +<td>yes</td> +<td>The ID of the profile.</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> +<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> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><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
