http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/to_extension.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/to_extension.html b/docs/1.1.2/development/traffic_ops_rest/to_extension.html new file mode 100644 index 0000000..cdddba6 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/to_extension.html @@ -0,0 +1,531 @@ + + +<!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>TO Extensions — Traffic Control 1.1.2 documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> + <link rel="next" title="Types" href="type.html"/> + <link rel="prev" title="System" href="system.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>TO Extensions</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/to_extension.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="to-extensions"> +<span id="to-api-ext"></span><h1>TO Extensions<a class="headerlink" href="#to-extensions" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/to_extensions.json</strong></p> +<p>Retrieves the list of extensions.</p> +<p>Authentication Required: Yes</p> +<p>Response Content Type: application/json</p> +<p><strong>Return Values</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="10%" /> +<col width="56%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">script_file</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">info_url</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">additional_config_json</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">isactive</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>{ + âresponseâ: [ + { + script_file: "ping", + version: "1.0.0", + name: "ILO_PING", + description: null, + info_url: "http://foo.com/bar.html", + additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }", + isactive: "1", + id: "1", + type: "CHECK_EXTENSION_BOOL", + servercheck_short_name: "ILO" + }, + { + script_file: "ping", + version: "1.0.0", + name: "10G_PING", + description: null, + info_url: "http://foo.com/bar.html", + additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }", + isactive: "1", + id: "2", + type: "CHECK_EXTENSION_BOOL", + servercheck_short_name: "10G" + } + ], + âversionâ: "1.1" +} +</pre></div> +</div> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/to_extensions</strong></p> +<blockquote> +<div><p>Creates a Traffic Ops extension.</p> +<p>Authentication Required: Yes</p> +<p><strong>Request Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="33%" /> +<col width="10%" /> +<col width="56%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">info_url</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">script_file</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">isactive</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">additional_config_json</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>{ + "name": "ILO_PING", + "version": "1.0.0", + "info_url": "http://foo.com/bar.html", + "script_file": "ping", + "isactive": "1", + "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}", + "description": null, + "servercheck_short_name": "ILO" + "type": "CHECK_EXTENSION_BOOL", +} +</pre></div> +</div> +<p>Response Content Type: application/json</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="15%" /> +<col width="63%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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/to_extensions/:id/delete</strong></p> +<blockquote> +<div><p>Deletes a Traffic Ops extension.</p> +<p>Authentication Required: Yes</p> +<p><strong>Request Route Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="23%" /> +<col width="29%" /> +<col width="49%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>yes</td> +<td>TO extension id</td> +</tr> +</tbody> +</table> +<p>Response Content Type: application/json</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="15%" /> +<col width="63%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre> { +"alerts": [ + { + "level": "success", + "text": "Extension deleted." + } +], +"version": "1.1" + } +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/type.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/type.html b/docs/1.1.2/development/traffic_ops_rest/type.html new file mode 100644 index 0000000..835f9e0 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/type.html @@ -0,0 +1,358 @@ + + +<!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 1.1.2 documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.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.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_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Types</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/type.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-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/types.json</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">useInTable</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span><span class="p">,</span> + <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span> + <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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.json</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p>Response Content Type: application/json</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/user.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/user.html b/docs/1.1.2/development/traffic_ops_rest/user.html new file mode 100644 index 0000000..52abc8c --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/user.html @@ -0,0 +1,1224 @@ + + +<!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 1.1.2 documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 1.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Ops" href="../traffic_ops.html"/> + <link rel="next" title="Traffic Router" href="../traffic_router.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.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_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_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current"> +<li class="toctree-l2 current"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Users</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/user.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router">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-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/users.json</strong></p> +<blockquote> +<div><p>Retrieves all users.</p> +<p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>hash</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">rolename</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">gid</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span> + <span class="p">{</span> + <span class="s">"email"</span><span class="p">:</span> <span class="s">"[email protected]"</span><span class="p">,</span> + <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"54"</span><span class="p">,</span> + <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Bob Simpson"</span><span class="p">,</span> + <span class="s">"localUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"username"</span><span class="p">:</span> <span class="s">"bsimpson"</span><span class="p">,</span> + <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"portal"</span><span class="p">,</span> + <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> + <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</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.json</strong></p> +<blockquote> +<div><p>Retrieves the profile for the authenticated user.</p> +<p>Authentication Required: Yes</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"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>{ + âresponseâ: { + âemailâ: "[email protected]", + âcityâ: "", + âidâ: "50", + âphoneNumberâ: "", + âcompanyâ: "", + âcountryâ: "", + âfullNameâ: "Tom Callahan", + âlocalUserâ: true, + âuidâ: "0", + âstateOrProvinceâ: "", + âusernameâ: "tommyboy", + ânewUserâ: false, + âaddressLine2â: "", + âroleâ: "6", + âaddressLine1â: "", + âgidâ: "0", + âpostalCodeâ: "" + }, + âversionâ: "1.1" +} +</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><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"><span class="pre">email</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">city</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">phoneNumber</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">company</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">country</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">fullName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">localUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">uid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stateOrProvince</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">username</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">newUser</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine2</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">addressLine1</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">gid</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">postalCode</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span> + <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span> + <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span> + <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span> + <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</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"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<p><strong>GET /api/1.1/user/current/jobs.json</strong></p> +<blockquote> +<div><p>Retrieves user purge jobs.</p> +<p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">keyword</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">objectName</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetType</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">dsXmlId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">username</span></code></td> +<td>boolean</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">enteredTime</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">objectType</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">agent</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span> + <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span> + <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span> + <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span> + <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"73"</span><span class="p">,</span> + <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"cim-jitp"</span><span class="p">,</span> + <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span> + <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span> + <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span> + <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> + <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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> +<blockquote> +<div><p>Creates a purge job.</p> +<p>Authentication Required: Yes</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"><span class="pre">dsId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dsXmlId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">regex</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ttl</span></code></td> +<td>int</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"73"</span><span class="p">,</span> + <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"cim-jitp"</span><span class="p">,</span> + <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span> + <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span> + <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Response Content Type: application/json</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>{ + âalertsâ: + [ + { + âlevelâ: "success", + âtextâ: "Successfully created purge job for: ." + } + ], + âversionâ: "1.1" +} +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>POST /api/1.1/user/login { u: ‘’, p: ‘’ }</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><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"><span class="pre">u</span></code></td> +<td>string</td> +<td>username</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><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-python"><div class="highlight"><pre> { + "u": "username", + "p": "password" +} +</pre></div> +</div> +<p>Response Content Type: application/json</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="24%" /> +<col width="15%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td> +<td>array</td> +<td>A collection of alert messages.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td>Success, info, warning or error.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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><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"><span class="pre">xmlId</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span> + <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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><strong>Request Route Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">t</span></code></td> +<td>string</td> +<td>token-value</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Response Content Type: application/json</p> +<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"><span class="pre">alerts</span></code></td> +<td>array</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">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"><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"><span class="pre">text</span></code></li> +</ul> +</td> +<td>string</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</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><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"><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-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"email"</span><span class="p">:</span> <span class="s">"[email protected]"</span> +<span class="p">}</span> +</pre></div> +</div> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">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"><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"><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"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span> + <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</span> + <span class="p">}</span> + <span class="p">],</span> + <span class="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router">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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
