http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v11/type.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v11/type.html b/docs/master/api/v11/type.html new file mode 100644 index 0000000..41b4533 --- /dev/null +++ b/docs/master/api/v11/type.html @@ -0,0 +1,502 @@ + + + + +<!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>Types — 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="Users" href="user.html"/> + <link rel="prev" title="TO Extensions" href="to_extension.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>Types</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v11/type.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="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="types"> +<span id="to-api-v11-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-1-types"> +<span id="to-api-v11-types-route"></span><h2>/api/1.1/types<a class="headerlink" href="#api-1-1-types" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.1/types</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="21%" /> +<col width="13%" /> +<col width="67%" /> +</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">useInTable</span></code></td> +<td>no</td> +<td>Filter types by the table in which they apply</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">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</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">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span> + <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.1/types/trimmed</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">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">"AAAA_RECORD"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<p><strong>GET /api/1.1/types/: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="21%" /> +<col width="13%" /> +<col width="67%" /> +</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>Type 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">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</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">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span> + <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span> + <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span> + <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</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="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><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/user.html ---------------------------------------------------------------------- diff --git a/docs/master/api/v11/user.html b/docs/master/api/v11/user.html new file mode 100644 index 0000000..28f4bf2 --- /dev/null +++ b/docs/master/api/v11/user.html @@ -0,0 +1,1500 @@ + + + + +<!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>Users — 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="API 1.2 Reference" href="../v12/index.html"/> + <link rel="prev" title="Types" href="type.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>Users</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/api/v11/user.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="../v12/index.html" class="btn btn-neutral float-right" title="API 1.2 Reference">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="users"> +<span id="to-api-v11-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-1-users"> +<span id="to-api-v11-users-route"></span><h2>/api/1.1/users<a class="headerlink" href="#api-1-1-users" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.1/users</strong></p> +<blockquote> +<div><p>Retrieves all users.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</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">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</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">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</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>hash</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">newUser</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</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">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"addressLine2"</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">""</span><span class="p">,</span> + <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"ema...@email.com"</span><span class="p">,</span> + <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span> + <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span> + <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span> + <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span> + <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="o">...</span> <span class="n">more</span> <span class="n">users</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/users/:id</strong></p> +<blockquote> +<div><p>Retrieves user by ID.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="15%" /> +<col width="68%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td> +<td>yes</td> +<td>User 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">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</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">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</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">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</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>hash</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">newUser</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</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">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"addressLine2"</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">""</span><span class="p">,</span> + <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"ema...@email.com"</span><span class="p">,</span> + <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span> + <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span> + <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span> + <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span> + <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span> + <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</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/user/current</strong></p> +<blockquote> +<div><p>Retrieves the profile for the authenticated user.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request 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">email</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">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</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="s2">"email"</span><span class="p">:</span> <span class="s2">"em...@email.com"</span><span class="p">,</span> + <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span> + <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span> + <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span> + <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span> + <span class="p">},</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/current/update</strong></p> +<blockquote> +<div><p>Updates the date for the authenticated user.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request 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">email</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">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"email"</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">""</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span> + <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> + <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> + <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"UserProfile was successfully updated."</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/user/current/jobs.json</strong></p> +<blockquote> +<div><p>Retrieves the userâs list of jobs.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="16%" /> +<col width="63%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td> +<td>no</td> +<td>PURGE</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">keyword</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">objectName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">assetType</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsXmlId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">enteredTime</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">objectType</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">agent</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">startTime</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> + <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span> + <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> + <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span> + <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span> + <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span> + <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span> + <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span> + <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST/api/1.1/user/current/jobs</strong></p> +<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p> +</div> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Yes</p> +<blockquote> +<div><p><strong>Request 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">dsId</span></code></td> +<td>string</td> +<td>Unique Delivery Service ID</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex</span></code></td> +<td>string</td> +<td>Path Regex this should be a +<a class="reference external" href="http://www.pcre.org/";>PCRE</a> compatible +regular expression for the path to match for +forcing the revalidation. Be careful to only +match on the content you need to remove - +revalidation is an expensive operation for +many origins, and a simple <code class="docutils literal notranslate"><span class="pre">/.*</span></code> can cause +an overload condition of the origin.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td> +<td>string</td> +<td>Start Time is the time when the revalidation +rule will be made active. Populate +with the current time to schedule ASAP.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td> +<td>int</td> +<td>Time To Live is how long the revalidation rule +will be active for in hours. It usually makes +sense to make this the same as the +<code class="docutils literal notranslate"><span class="pre">Cache-Control</span></code> header from the origin which +sets the object time to live in cache +(by <code class="docutils literal notranslate"><span class="pre">max-age</span></code> or <code class="docutils literal notranslate"><span class="pre">Expires</span></code>). Entering a +longer TTL here will make the caches do +unnecessary work.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span> + <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span> + <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"Successfully created purge job for: ."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/login</strong></p> +<blockquote> +<div><p>Authentication of a user using username and password. Traffic Ops will send back a session cookie.</p> +<p>Authentication Required: No</p> +<p>Role(s) Required: None</p> +<p><strong>Request 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">u</span></code></td> +<td>string</td> +<td>username</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">p</span></code></td> +<td>string</td> +<td>password</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span> + <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"Successfully logged in."</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/user/:id/deliveryservices/available.json</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="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>id</td> +<td>yes</td> +<td> </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">xmlId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</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">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/login/token</strong></p> +<blockquote> +<div><p>Authentication of a user using a token.</p> +<p>Authentication Required: No</p> +<p>Role(s) Required: None</p> +<p><strong>Request 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">t</span></code></td> +<td>string</td> +<td>token-value</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="38%" /> +<col width="24%" /> +<col width="38%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"error"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/logout</strong></p> +<blockquote> +<div><p>User logout. Invalidates the session cookie.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: None</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td> </td> +</tr> +<tr class="row-odd"><td><ul class="first last simple"> +<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li> +</ul> +</td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><ul class="first last simple"> +<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li> +</ul> +</td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"You are logged out."</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/reset_password</strong></p> +<blockquote> +<div><p>Reset user password.</p> +<p>Authentication Required: No</p> +<p>Role(s) Required: None</p> +<p><strong>Request 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">email</span></code></td> +<td>string</td> +<td>The email address of the user to initiate +password reset.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"em...@email.com"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><ul class="first last simple"> +<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li> +</ul> +</td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><ul class="first last simple"> +<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li> +</ul> +</td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="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">"Successfully sent password reset to email 'em...@email.com'"</span> + <span class="p">}</span> + <span class="p">],</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../v12/index.html" class="btn btn-neutral float-right" title="API 1.2 Reference">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="type.html" class="btn btn-neutral" title="Types"><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
